Setup with Docker (Simple)

In this version, there is only one Docker container needed and one optional for the database. If you use a managed database outside of Docker, you only have to run one single container. This is useful for environments where access to Docker is limited, e.g. on Heroku or other cloud platforms. However, if you have full access to a VPS or root server, the advanced setup is recommended as it also improves the performance.

Docker images used in this setup are named linkace/linkace:simple or linkace/linkace:0.0.42-simple.

Base Requirements

  • Shell access to your server.
  • Docker version 19 or greater.
  • docker-compose is recommended for the setup, must support compose version 3.
  • Please consider using utf8mb4_bin as the database collation. Other collations like utf8mb4_general_ci may cause issues with different Unicode characters.
If you are using an ARM v7 operating system, please make sure that you have the latest version of libseccomp2 (> 2.4.4) installed. Otherwise, you will run into issues with our Docker images. A guide can be found on linuxserver.io.

Setup with Docker

1. Copy the needed files

Copy the following files from the repository to the directory you want to use for the application. You don’t need any other files to run LinkAce.

  • docker-compose.production-simple.yml
  • .env.docker.production

2. Modify the files

  • Rename the .env.docker.production to .env.
  • Rename the docker-compose.production-simple.yml to docker-compose.yml.

By default, you only have change two variables set in this file before starting the setup:

  • DB_PASSWORD - Please set a secure password here
  • REDIS_PASSWORD - Please set a secure password here

3. Start the application

After you completed the above steps, run the following command to start up the container setup:

docker-compose up -d

4. Set a secure key

After you started the Docker containers, you are almost ready to run the setup. Before the setup, we have to generate a secret key.

Please note that linkace_app_1 is the name of your LinkAce container here. It may differ from your name. You will find the name of your container in the output of the previous command, but will most likely end with _app_1.
docker exec linkace_app_1 php artisan key:generate

5. Start the built-in setup

Open the URL which points to your Docker container in your browser now. You configure the database and your user account in the following process.

Please make sure to follow the post-installation steps now to fully enable all features.

The advanced Docker configuration page provides some guides for specific use cases for Docker.