Upgrade from LinkAce v1

Warning: This is the documentation of a beta version of LinkAce. Things may break. Only use this version for tests.

Table of Contents

General upgrade guide

Please follow these instructions to upgrade LinkAce to the new version 2.

Preparation

⚠️ MAKE A BACKUP OF LINKACE, INCLUDING THE DATABASE!!! ⚠️
There will be absolutely no help to restore your old LinkAce installation and database in case of a failed migration!

Breaking changes

  • LinkAce v2 now supports multiple users and comes with a more sophisticated system for the visibility of links, lists, tags and notes.
    • All entries that are currently marked as private will remain as such.
    • If you enable Guest Mode before the upgrade, links marked as public will stay public.
      However, if you have Guest Mode disabled, public links will become internal. This means they are visible to all logged-in users, but not to guests.
  • Your current user will become the primary administrator who can now control some system settings, as well as inviting users to LinkAce.
  • The API was updated to version v2. Any existing integrations must be checked and adjusted if needed.

Upgrade a Docker installation

  1. Stop your current containers: 
    docker compose down
  2. LinkAce no longer provides the advanced Docker image. LinkAce is now available as a complete Docker container including a webserver.
  3. If you have a service called nginx in your docker-compose.yml file, remove this service completely!
    Due to a change in the default web server, there is no upgrade guide if you are running LinkAce directly with SSL certificates to provide HTTPS. Please consult the steps to configure HTTPS with Docker for all needed changes.
  4. Pull the new image: 
    docker pull linkace/linkace:2.x
  5. Restart your container: 
    docker compose up -d
  6. Run the database migrations and delete the current cache. The migration can take quite a while depending on your amount of links, lists and tags saved. 
    docker compose exec app php artisan migrate
docker compose exec app php artisan cache:clear
    You may get a warning about running the migration in production mode. You should confirm the migration by answering with yes.

Upgrade a non-Docker installation

  1. Get the latest version of LinkAce by downloading the package from the releases page. Overwrite all existing files with the new ones. If you want to keep your log files, skip the storage/logs folder.
  2. Run the database migrations which are needed after all updates and delete the current cache: 
    php artisan migrate
php artisan cache:clear
    You may get a warning about running the migration in production mode. You should confirm the migration by answering with yes. This process will take a while.