Skip to content

Latest commit

 

History

History
318 lines (232 loc) · 10.2 KB

README.md

File metadata and controls

318 lines (232 loc) · 10.2 KB
Raw


Docker Edition


Pull, deploy, enjoy!


About • About LinkStack • Pull • Supported Architectures • Deployment • Updating • Build • Persistent storage • Reverse Proxy


Live Demo

Docker Hub

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

LinkStack is a highly customizable link sharing platform with an intuitive, easy to use user interface.

LinkStack allows you to create a personal profile page. Many social media platforms only allow for one link. With this, you can have all the links you want clickable on one site. Set up your personal site on your own server in a few clicks.


Learn more about LinkStack, and all the features here:


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

  • SERVER_ADMIN (the email, defaults to you@example.com)
  • HTTP_SERVER_NAME (the server name, defaults to localhost)
  • HTTPS_SERVER_NAME (the server name, defaults to localhost)
  • LOG_LEVEL (the log level, defaults to info)
  • TZ (the timezone, defaults to UTC)
  • PHP_MEMORY_LIMIT (the memory-limit, defaults to 256M)
  • UPLOAD_MAX_FILESIZE (the upload_max_filesize, defaults to 8M)

Deploy


Read more about persistent storage


Create a new volume:

docker volume create linkstack

docker run --detach \
    --name linkstack \
    --publish 80:80 \
    --publish 443:443 \
    --restart unless-stopped \
    --mount source=linkstack,target=/htdocs \
    linkstackorg/linkstack

Custom deployment

docker run --detach \
    --name linkstack \
    --hostname linkstack \
    --env HTTP_SERVER_NAME="www.example.xyz" \
    --env HTTPS_SERVER_NAME="www.example.xyz" \
    --env SERVER_ADMIN="admin@example.xyz" \
    --env TZ="Europe/Berlin" \
    --env PHP_MEMORY_LIMIT="512M" \
    --env UPLOAD_MAX_FILESIZE="16M" \
    --publish 80:80 \
    --publish 443:443 \
    --restart unless-stopped \
    --mount source=linkstack,target=/htdocs \
    linkstackorg/linkstack

Docker Compose

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

version: "3.8"

services:

  linkstack:
    hostname: 'linkstack'
    image: 'linkstackorg/linkstack:latest'
    environment:
      TZ: 'Europe/Berlin'
      SERVER_ADMIN: 'admin@example.com'
      HTTP_SERVER_NAME: 'example.com'
      HTTPS_SERVER_NAME: 'example.com'
      LOG_LEVEL: 'info'
      PHP_MEMORY_LIMIT: '256M'
      UPLOAD_MAX_FILESIZE: '8M'
    volumes:
      - 'linkstack_data:/htdocs'
    ports:
      - '8190:443'
    restart: unless-stopped

volumes:
  linkstack_data:

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:

docker build -t linkstack .
You can now set up your application on your defined ports.

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:

If you wish to save only selective files, you may save the following files and folders: 
/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

server {
  listen        443 ssl;
  listen        [::]:443 ssl;
  listen        80;
  listen        [::]:80;
  server_name   your.domain.name;

  location / {
    # Replace with the IP address and port number of your Docker container.
    proxy_pass                          https://127.0.0.1:443;
    proxy_set_header Host               $host;
    proxy_set_header X-Real-IP          $remote_addr;

    proxy_set_header X-Forwarded-For    $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto  https;
    proxy_set_header X-VerifiedViaNginx yes;
    proxy_read_timeout                  60;
    proxy_connect_timeout               60;
    proxy_redirect                      off;

    # Specific for websockets: force the use of HTTP/1.1 and set the Upgrade header
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection 'upgrade';
    proxy_cache_bypass $http_upgrade;
    proxy_set_header X-Forwarded-Proto $scheme;
    
    # Fixes Mixed Content errors.
    add_header 'Content-Security-Policy' 'upgrade-insecure-requests';
  }
}