{"id":15026926,"url":"https://github.com/linkstackorg/linkstack-docker","last_synced_at":"2025-04-08T11:08:00.281Z","repository":{"id":43232405,"uuid":"504197955","full_name":"LinkStackOrg/linkstack-docker","owner":"LinkStackOrg","description":"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.","archived":false,"fork":false,"pushed_at":"2025-02-17T19:41:23.000Z","size":110,"stargazers_count":401,"open_issues_count":7,"forks_count":47,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-08T11:07:56.076Z","etag":null,"topics":["alpine","alpine-linux","apache","apache2","blade","css","docker","javascript","laravel","link","linkstack","linktree","linktree-alternative","open-source","personal-website","php","php8","self-hosted","webapp"],"latest_commit_sha":null,"homepage":"https://linkstack.org/docker","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LinkStackOrg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"JulianPrieber","patreon":"JulianPrieber","liberapay":"LinkStack","custom":["paypal.me/JulianPrieber","buymeacoffee.com/JulianPrieber"]}},"created_at":"2022-06-16T14:57:23.000Z","updated_at":"2025-04-07T21:37:53.000Z","dependencies_parsed_at":"2025-02-24T17:03:11.640Z","dependency_job_id":"874ddbf0-642d-438a-bfa9-50ef8ced709a","html_url":"https://github.com/LinkStackOrg/linkstack-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinkStackOrg%2Flinkstack-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinkStackOrg%2Flinkstack-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinkStackOrg%2Flinkstack-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinkStackOrg%2Flinkstack-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LinkStackOrg","download_url":"https://codeload.github.com/LinkStackOrg/linkstack-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247829491,"owners_count":21002995,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alpine","alpine-linux","apache","apache2","blade","css","docker","javascript","laravel","link","linkstack","linktree","linktree-alternative","open-source","personal-website","php","php8","self-hosted","webapp"],"created_at":"2024-09-24T20:05:24.620Z","updated_at":"2025-04-08T11:08:00.245Z","avatar_url":"https://github.com/LinkStackOrg.png","language":"Shell","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"200px\" src=\"https://raw.githubusercontent.com/LinkStackOrg/branding/main/logo/svg/logo_animated.svg\"\u003e\u003cbr\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" width=\"400px\" srcset=\"https://raw.githubusercontent.com/LinkStackOrg/branding/main/badges/png/website_light.png\"\u003e\n    \u003cimg width=\"400px\" src=\"https://raw.githubusercontent.com/LinkStackOrg/branding/main/badges/png/website_dark.png\"\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n  \n\u003ch3 align=\"center\"\u003eDocker Edition\u003c/h3\u003e\u003cbr\u003e\n\u003ch4 align=\"center\"\u003ePull, deploy, enjoy!\u003c/h3\u003e\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#1\"\u003eAbout\u003c/a\u003e •\n  \u003ca href=\"#2\"\u003eAbout LinkStack\u003c/a\u003e •\n  \u003ca href=\"#3\"\u003ePull\u003c/a\u003e •\n  \u003ca href=\"#4\"\u003eSupported Architectures\u003c/a\u003e •\n  \u003ca href=\"#5\"\u003eDeployment\u003c/a\u003e •\n  \u003ca href=\"#6\"\u003eUpdating\u003c/a\u003e •\n  \u003ca href=\"#7\"\u003eBuild\u003c/a\u003e •\n  \u003ca href=\"#8\"\u003ePersistent storage\u003c/a\u003e •\n  \u003ca href=\"#9\"\u003eReverse Proxy\u003c/a\u003e\n\u003c/p\u003e\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003e\u003ca href=\"https://linksta.cc\"\u003eLive Demo\u003c/a\u003e\u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/linkstackorg/linkstack-docker/stargazers\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/linkstackorg/linkstack-docker?logo=github\u0026style=flat\u0026logo=appveyor\u0026label=star%20this%20project\"\u003e\u003c/img\u003e\u003c/a\u003e\n\u003ca href=\"https://discord.linkstack.com\"\u003e\u003cimg src=\"https://img.shields.io/discord/955765706111193118?color=4A55CC\u0026label=Discord\u0026logo=discord\u0026style=flat\u0026logo=appveyor\"\u003e\u003c/img\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/sponsors/linkstackorg\"\u003e\u003cimg src=\"https://img.shields.io/github/sponsors/julianprieber?color=BF4B8A\u0026logo=githubsponsors\u0026style=flat\u0026logo=appveyor=Sponsor%20on%20Github\"\u003e\u003c/img\u003e\u003c/a\u003e\n\u003ca href=\"https://patreon.com/julianprieber\"\u003e\u003cimg src=\"https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Djulianprieber%26type%3Dpatrons\u0026style=flat\u0026logo=appveyor\"\u003e\u003c/img\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://hub.docker.com/r/linkstackorg/linkstack\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/LinkStackOrg/branding/main/badges/png/docker-hub.png\" alt=\"Docker Hub\" width=\"280\" \u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003ca name=\"1\"\u003e\u003c/a\u003e\n## About\n\nThe official docker version of [LinkStack](https://github.com/linkstackorg/linkstack). This docker image is a simple to set up solution, containing everything you need to run LinkStack.\n\nThe docker version of LinkStack retains all the features and customization options of the [original version](https://github.com/linkstackorg/linkstack).\n\nThis docker is based on [Alpine Linux](https://www.alpinelinux.org/), a Linux distribution designed to be small, simple and secure. The web server is running [Apache2](https://www.apache.org/), a free and open-source cross-platform web server software. The docker comes with [PHP 8.2](https://www.php.net/releases/8.2/en.php) for high compatibility and performance.\n\n#### Using the docker is as simple as pulling and deploying.\n\n\u003cbr\u003e\n\n\u003ca name=\"2\"\u003e\u003c/a\u003e\n## About LinkStack\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/linkstackorg/linkstack-docker\"\u003e\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" width=\"600px\" srcset=\"https://raw.githubusercontent.com/LinkStackOrg/branding/main/marketing/docker_edition_dark.png\"\u003e\n  \u003cimg width=\"600px\" src=\"https://raw.githubusercontent.com/LinkStackOrg/branding/main/marketing/docker_edition_light.png\"\u003e\n\u003c/picture\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cstrong\u003eLinkStack is a highly customizable link sharing platform with an intuitive, easy to use user interface.\u003c/strong\u003e\n    \n\u003cp align=\"center\"\u003eLinkStack 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.\u003c/p\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cstrong\u003eLearn more about LinkStack, and all the features here:\u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/linkstackorg/linkstack\"\u003eAbout LinkStack\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003ca name=\"3\"\u003e\u003c/a\u003e\n## Pull\n\n```shell\ndocker pull linkstackorg/linkstack\n```\n\n\u003cbr\u003e\n\n\u003ci\u003eAlternative mirror:\u003c/i\u003e\n\n```shell\ndocker pull ghcr.io/linkstackorg/linkstack\n```\n\n\u003cbr\u003e\n\n\u003ca name=\"4\"\u003e\u003c/a\u003e\n## Supported Architectures\n\n- [`linux/amd64`](https://hub.docker.com/r/linkstackorg/linkstack/tags)\n- [`linux/arm/v6`](https://hub.docker.com/r/linkstackorg/linkstack/tags)\n- [`linux/arm/v7`](https://hub.docker.com/r/linkstackorg/linkstack/tags)\n- [`linux/arm64`](https://hub.docker.com/r/linkstackorg/linkstack/tags)\n\n\u003cbr\u003e\n\n\u003ca name=\"5\"\u003e\u003c/a\u003e\n## Deployment\n\nYou may change port *80*, *443* to your preferred values.  \n\nBoth HTTP and HTTPS are supported and exposed by default.\n\n### Optional environment variables\n\n- `SERVER_ADMIN` (the email, defaults to `you@example.com`)\n- `HTTP_SERVER_NAME` (the [server name](https://httpd.apache.org/docs/2.4/fr/mod/core.html#servername), defaults to `localhost`)\n- `HTTPS_SERVER_NAME` (the [server name](https://httpd.apache.org/docs/2.4/fr/mod/core.html#servername), defaults to `localhost`)\n- `LOG_LEVEL` (the [log level](https://httpd.apache.org/docs/2.4/fr/mod/core.html#loglevel), defaults to `info`)\n- `TZ` (the [timezone](https://www.php.net/manual/timezones.php), defaults to `UTC`)\n- `PHP_MEMORY_LIMIT` (the [memory-limit](https://www.php.net/manual/ini.core.php#ini.memory-limit), defaults to `256M`)\n- `UPLOAD_MAX_FILESIZE` (the [upload_max_filesize](https://www.php.net/manual/en/ini.core.php#ini.upload-max-filesize), defaults to `8M`)\n\n\u003cbr\u003e\n\n#### Deploy\n\n\u003ca href=\"#deploy\"\u003e\u003cimg width=\"350\" src=\"https://img.shields.io/badge/-We%20recommend%20setting%20up%20persistent%20storage-yellow\"\u003e\u003c/a\u003e\u003cbr\u003e\n\u003ca href=\"#8\"\u003e\u003ci\u003eRead more about persistent storage\u003c/i\u003e\u003c/a\u003e\n\n\u003cbr\u003e\n\n**Create a new volume:**\n\u003cpre\u003edocker volume create linkstack\u003c/pre\u003e\n\n\u003cbr\u003e\n\n\u003cpre\u003e\ndocker run --detach \\\n    --name linkstack \\\n    --publish 80:80 \\\n    --publish 443:443 \\\n    --restart unless-stopped \\\n    --mount source=linkstack,target=/htdocs \\\n    linkstackorg/linkstack\n\u003c/pre\u003e\n\n\u003cbr\u003e\n\n#### Custom deployment\n\n\u003cpre\u003e\ndocker run --detach \\\n    --name linkstack \\\n    --hostname linkstack \\\n    --env HTTP_SERVER_NAME=\"www.example.xyz\" \\\n    --env HTTPS_SERVER_NAME=\"www.example.xyz\" \\\n    --env SERVER_ADMIN=\"admin@example.xyz\" \\\n    --env TZ=\"Europe/Berlin\" \\\n    --env PHP_MEMORY_LIMIT=\"512M\" \\\n    --env UPLOAD_MAX_FILESIZE=\"16M\" \\\n    --publish 80:80 \\\n    --publish 443:443 \\\n    --restart unless-stopped \\\n    --mount source=linkstack,target=/htdocs \\\n    linkstackorg/linkstack\n\u003c/pre\u003e\n\n\u003cbr\u003e\n\n#### Docker Compose\n\u003cins\u003eUse HTTPS for your reverse proxy to avoid issues\u003c/ins\u003e\u003cbr\u003e\nExample config.\n\n\u003cpre\u003e\nversion: \"3.8\"\n\nservices:\n\n  linkstack:\n    hostname: 'linkstack'\n    image: 'linkstackorg/linkstack:latest'\n    environment:\n      TZ: 'Europe/Berlin'\n      SERVER_ADMIN: 'admin@example.com'\n      HTTP_SERVER_NAME: 'example.com'\n      HTTPS_SERVER_NAME: 'example.com'\n      LOG_LEVEL: 'info'\n      PHP_MEMORY_LIMIT: '256M'\n      UPLOAD_MAX_FILESIZE: '8M'\n    volumes:\n      - 'linkstack_data:/htdocs'\n    ports:\n      - '8190:443'\n    restart: unless-stopped\n\nvolumes:\n  linkstack_data:\n\u003c/pre\u003e\n\n\u003cbr\u003e\n\n\u003ca name=\"6\"\u003e\u003c/a\u003e\n## Updating\n\nWhen a **new version** is released, you will get an update notification on your Admin Panel.\n\n### Automatic one click Updater\nThis updater allows you to update your installation with just one click.\n\n\u003cbr\u003e\t\n\n**How to use the Automatic Updater:**\n\n- To update your instance, click on the update notification on your Admin Panel.\n\n- Click on “Update automatically” and the updater will take care of the rest.\n\n\u003cbr\u003e\n\n\u003ca name=\"7\"\u003e\u003c/a\u003e\n## Build\n\n**If you wish to build or modify your own docker version of LinkStack, you can do so with the instructions below:**\n\n- Download this GitHub repository as well as the latest release of LinkStack from [here](https://github.com/linkstackorg/linkstack/releases/latest/download/linkstack.zip).\n- Place the downloaded release files directly into the linkstack folder from [this repository](https://github.com/linkstackorg/linkstack-docker/archive/refs/heads/main.zip).\n\nFrom the docker directory, run the command:\n\u003cpre\u003e\ndocker build -t linkstack .\n\u003c/pre\u003eYou can now set up your application on your defined ports.\n\n\u003cbr\u003e\n\n\u003ca name=\"8\"\u003e\u003c/a\u003e\n## Persistent storage\n\nPersistent storage for docker containers is storage that is **not** lost when the container is stopped or removed.\n\nThis 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.\n\n\nAll files important to run LinkStack are stored in the \"htdocs\" folder found in the root directory of your docker container.\n\nWe recommend mounting that entire folder to an external volume.\n\n\u003cbr\u003e\n\n**However, some user may prefer to preserve only individual files.** \u003cbr\u003e\n_Expand the details section below to read more about this:_\n\n\u003cdetails\u003e\nIf you wish to save only selective files, you may save the following files and folders:\n\n```\n/htdocs/.env\n/htdocs/database/database.sqlite\n/htdocs/config/advanced-config.php\n/htdocs/assets/linkstack/images/avatar.png\n/htdocs/themes (folder)\n/htdocs/assets/img (folder)\n```\n\n**This might change with future releases.**\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n\u003ca name=\"9\"\u003e\u003c/a\u003e\n## Reverse Proxy\n\n### NGINX:\n\n**Below is an example NGINX setup for a reverse proxy.**\u003cbr\u003e\n\u003cins\u003eMake sure to use HTTPS to access your container to avoid mixed content errors\u003c/ins\u003e\n\u003cpre\u003e\n\nserver {\n  listen        443 ssl;\n  listen        [::]:443 ssl;\n  listen        80;\n  listen        [::]:80;\n  server_name   your.domain.name;\n\n  location / {\n    # Replace with the IP address and port number of your Docker container.\n    proxy_pass                          https://127.0.0.1:443;\n    proxy_set_header Host               $host;\n    proxy_set_header X-Real-IP          $remote_addr;\n\n    proxy_set_header X-Forwarded-For    $proxy_add_x_forwarded_for;\n    proxy_set_header X-Forwarded-Proto  https;\n    proxy_set_header X-VerifiedViaNginx yes;\n    proxy_read_timeout                  60;\n    proxy_connect_timeout               60;\n    proxy_redirect                      off;\n\n    # Specific for websockets: force the use of HTTP/1.1 and set the Upgrade header\n    proxy_http_version 1.1;\n    proxy_set_header Upgrade $http_upgrade;\n    proxy_set_header Connection 'upgrade';\n    proxy_cache_bypass $http_upgrade;\n    proxy_set_header X-Forwarded-Proto $scheme;\n    \n    # Fixes Mixed Content errors.\n    add_header 'Content-Security-Policy' 'upgrade-insecure-requests';\n  }\n}\n\n\u003c/pre\u003e\n\n\u003cbr\u003e\n\u003cbr\u003e\n","funding_links":["https://github.com/sponsors/JulianPrieber","https://patreon.com/JulianPrieber","https://liberapay.com/LinkStack","paypal.me/JulianPrieber","buymeacoffee.com/JulianPrieber","https://github.com/sponsors/linkstackorg","https://patreon.com/julianprieber"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinkstackorg%2Flinkstack-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinkstackorg%2Flinkstack-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinkstackorg%2Flinkstack-docker/lists"}