linkstack-docker

A simple to set up docker variant of LinkStack. LinkStack is a highly customizable link sharing platform with an intuitive, easy to use user interface.

AGPL-3.0 License

Stars
340

About

The official docker version of LinkStack. This docker image is a simple to set up solution, containing everything you need to run LinkStack.

The docker version of LinkStack retains all the features and customization options of the original version.

This docker is based on Alpine Linux, a Linux distribution designed to be small, simple and secure. The web server is running Apache2, a free and open-source cross-platform web server software. The docker comes with PHP 8.2 for high compatibility and performance.

Using the docker is as simple as pulling and deploying.

About LinkStack

Pull

docker pull linkstackorg/linkstack

Alternative mirror:

docker pull ghcr.io/linkstackorg/linkstack

Supported Architectures

Deployment

You may change port 80, 443 to your preferred values.

Both HTTP and HTTPS are supported and exposed by default.

Optional environment variables

Deploy

Read more about persistent storage

Create a new volume:

Custom deployment

Docker Compose

Use HTTPS for your reverse proxy to avoid issues Example config.

Updating

When a new version is released, you will get an update notification on your Admin Panel.

Automatic one click Updater

This updater allows you to update your installation with just one click.

How to use the Automatic Updater:

  • To update your instance, click on the update notification on your Admin Panel.

  • Click on “Update automatically” and the updater will take care of the rest.

Build

If you wish to build or modify your own docker version of LinkStack, you can do so with the instructions below:

  • Download this GitHub repository as well as the latest release of LinkStack from here.
  • Place the downloaded release files directly into the linkstack folder from this repository.

From the docker directory, run the command:

Persistent storage

Persistent storage for docker containers is storage that is not lost when the container is stopped or removed.

This is advantageous since it means that data may be saved even if the container is removed. This is especially crucial when dealing with data that must be retained throughout restarts, such as a database.

All files important to run LinkStack are stored in the "htdocs" folder found in the root directory of your docker container.

We recommend mounting that entire folder to an external volume.

However, some user may prefer to preserve only individual files. Expand the details section below to read more about this:

/htdocs/.env
/htdocs/database/database.sqlite
/htdocs/config/advanced-config.php
/htdocs/assets/linkstack/images/avatar.png
/htdocs/themes (folder)
/htdocs/assets/img (folder)

This might change with future releases.

Reverse Proxy

NGINX:

Below is an example NGINX setup for a reverse proxy. Make sure to use HTTPS to access your container to avoid mixed content errors