From e97ca4ae1c37ab22eb7ea6b0933fd1b65385998a Mon Sep 17 00:00:00 2001 From: Julian Prieber Date: Mon, 1 May 2023 15:22:09 +0200 Subject: [PATCH] Name change --- Dockerfile | 4 +- README.md | 68 ++++++++++++++--------------- SECURITY.md | 4 +- contrib/swarm-deploy/deploy.sh | 2 +- contrib/swarm-deploy/littlelink.yml | 2 +- docker-entrypoint.sh | 4 +- linkstack/.gitignore | 2 +- 7 files changed, 43 insertions(+), 43 deletions(-) diff --git a/Dockerfile b/Dockerfile index 91c3ddc..52b73dd 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,6 @@ FROM alpine:3.17.2 LABEL maintainer="JulianPrieber" -LABEL description="LittleLink Custom Docker" +LABEL description="LinkStack Docker" EXPOSE 80 443 @@ -37,7 +37,7 @@ RUN apk --no-cache --update \ tzdata \ && mkdir /htdocs -COPY littlelink-custom /htdocs +COPY linkstack /htdocs RUN chown -R apache:apache /htdocs RUN find /htdocs -type d -print0 | xargs -0 chmod 0755 RUN find /htdocs -type f -print0 | xargs -0 chmod 0644 diff --git a/README.md b/README.md index cbbecbe..9308cc8 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@

- LittleLink Custom + LinkStack

Pull, deploy, enjoy!


About • - About LittleLink Custom • + About LinkStack • Pull • Supported Architectures • Deployment • @@ -17,27 +17,27 @@


- Live Demo + Live Demo

- - + +

- Docker Hub + Docker Hub

## About -The official docker version of [LittleLink Custom](https://github.com/JulianPrieber/littlelink-custom). This docker image is a simple to set up solution, containing everything you need to run LittleLink Custom. +The official docker version of [LinkStack](https://github.com/JulianPrieber/linkstack). This docker image is a simple to set up solution, containing everything you need to run LinkStack. -The docker version of LittleLink Custom retains all the features and customization options of the [original version](https://github.com/JulianPrieber/littlelink-custom). +The docker version of LinkStack retains all the features and customization options of the [original version](https://github.com/JulianPrieber/linkstack). This 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.0](https://www.php.net/releases/8.0/en.php) for high compatibility and performance. @@ -46,28 +46,28 @@ This docker is based on [Alpine Linux](https://www.alpinelinux.org/), a Linux di
-## About LittleLink Custom +## About LinkStack

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

LittleLink Custom 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.

+

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 LittleLink Custom, and all the features here: +Learn more about LinkStack, and all the features here:


- About + About


@@ -75,17 +75,17 @@ This docker is based on [Alpine Linux](https://www.alpinelinux.org/), a Linux di ## Pull -`docker pull julianprieber/littlelink-custom` +`docker pull julianprieber/linkstack`
## Supported Architectures -- [`linux/amd64`](https://hub.docker.com/r/julianprieber/littlelink-custom/tags) -- [`linux/arm/v6`](https://hub.docker.com/r/julianprieber/littlelink-custom/tags) -- [`linux/arm/v7`](https://hub.docker.com/r/julianprieber/littlelink-custom/tags) -- [`linux/arm64`](https://hub.docker.com/r/julianprieber/littlelink-custom/tags) +- [`linux/amd64`](https://hub.docker.com/r/julianprieber/linkstack/tags) +- [`linux/arm/v6`](https://hub.docker.com/r/julianprieber/linkstack/tags) +- [`linux/arm/v7`](https://hub.docker.com/r/julianprieber/linkstack/tags) +- [`linux/arm64`](https://hub.docker.com/r/julianprieber/linkstack/tags)
@@ -122,12 +122,12 @@ Both HTTP and HTTPS are supported and exposed by default. 
 docker run --detach \
-    --name littlelink-custom \
+    --name linkstack \
     --publish 80:80 \
     --publish 443:443 \
     --restart unless-stopped \
     --mount source=llc,target=/htdocs \
-    julianprieber/littlelink-custom
+    julianprieber/linkstack

@@ -136,8 +136,8 @@ docker run --detach \ 
 docker run --detach \
-    --name littlelink-custom \
-    --hostname littlelink-custom \
+    --name linkstack \
+    --hostname linkstack \
     --env HTTP_SERVER_NAME="www.example.xyz" \
     --env HTTPS_SERVER_NAME="www.example.xyz" \
     --env SERVER_ADMIN="admin@example.xyz" \
@@ -148,7 +148,7 @@ docker run --detach \
     --publish 443:443 \
     --restart unless-stopped \
     --mount source=llc,target=/htdocs \
-    julianprieber/littlelink-custom
+    julianprieber/linkstack

@@ -161,9 +161,9 @@ version: "3.8" services: - littlelink-custom: - hostname: 'littlelink-custom' - image: 'julianprieber/littlelink-custom:latest' + linkstack: + hostname: 'linkstack' + image: 'julianprieber/linkstack:latest' environment: TZ: 'Europe/Berlin' SERVER_ADMIN: 'youremail@gmail.com' @@ -199,10 +199,10 @@ networks:
### Optional configuration: -Optionally, you can change the app name in your ".env" file in the root directory of your LittleLink Custom installation. At the moment this is set to -APP_NAME="LittleLink Custom" you can change "LittleLink Custom" to what ever you like. This setting defines the page title and welcome message. +Optionally, you can change the app name in your ".env" file in the root directory of your LinkStack installation. At the moment this is set to +APP_NAME="LinkStack" you can change "LinkStack" to what ever you like. This setting defines the page title and welcome message. -For more configuration options, refer to the [documentation](https://littlelink-custom.com/docs/d/configuration-getting-started/). +For more configuration options, refer to the [documentation](https://linkstack.com/docs/d/configuration-getting-started/).
@@ -227,14 +227,14 @@ This updater allows you to update your installation with just one click. ## Build -**If you wish to build or modify your own docker version of LittleLink Custom, you can do so with the instructions below:** +**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 LittleLink Custom from [here](https://github.com/JulianPrieber/littlelink-custom/releases/latest/download/littlelink-custom.zip). -- Place the downloaded release files directly into the littlelink-custom folder from [this repository](https://github.com/JulianPrieber/llc-docker/archive/refs/heads/main.zip). +- Download this GitHub repository as well as the latest release of LinkStack from [here](https://github.com/JulianPrieber/linkstack/releases/latest/download/linkstack.zip). +- Place the downloaded release files directly into the linkstack folder from [this repository](https://github.com/JulianPrieber/llc-docker/archive/refs/heads/main.zip). From the docker directory, run the command: 
-docker build -t littlelink-custom .
+docker build -t linkstack .
You can now set up your application on your defined ports.
@@ -247,7 +247,7 @@ Persistent storage for docker containers is storage that is **not** lost when th 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 LittleLink Custom are stored in the "htdocs" folder found in the root directory of your docker container. +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. diff --git a/SECURITY.md b/SECURITY.md index c77b229..04376a2 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -7,8 +7,8 @@ The security of this application is left to the user. This application is distri ## Reporting a Vulnerability -If you believe you have found a security vulnerability in this project, please contact the developer at [`littlelink.custom@gmail.com`](mailto:littlelink.custom@gmail.com). Include as much detail as possible about the potential issue, including the version of the project you are using. Thank you for helping to keep LittleLink Custom secure! +If you believe you have found a security vulnerability in this project, please contact the developer at [`linkstackorg@gmail.com`](mailto:linkstackorg@gmail.com). Include as much detail as possible about the potential issue, including the version of the project you are using. Thank you for helping to keep LinkStack secure!
-*For any questions regarding this please contact: [`littlelink.custom@gmail.com`](mailto:littlelink.custom@gmail.com)* +*For any questions regarding this please contact: [`linkstackorg@gmail.com`](mailto:linkstackorg@gmail.com)* diff --git a/contrib/swarm-deploy/deploy.sh b/contrib/swarm-deploy/deploy.sh index ff2ea8c..dd7d14e 100644 --- a/contrib/swarm-deploy/deploy.sh +++ b/contrib/swarm-deploy/deploy.sh @@ -1,2 +1,2 @@ #!/bin/bash -docker stack deploy -c littlelink.yml littlelink +docker stack deploy -c linkstack.yml linkstack diff --git a/contrib/swarm-deploy/littlelink.yml b/contrib/swarm-deploy/littlelink.yml index b1d3419..2e98b96 100644 --- a/contrib/swarm-deploy/littlelink.yml +++ b/contrib/swarm-deploy/littlelink.yml @@ -35,7 +35,7 @@ services: php artisan migrate --force exec /docker-entrypoint.sh server - image: "julianprieber/littlelink-custom:latest" + image: "julianprieber/linkstack:latest" environment: TZ: "Europe/Berlin" HTTP_SERVER_NAME: "" diff --git a/docker-entrypoint.sh b/docker-entrypoint.sh index 16b7574..228cf94 100644 --- a/docker-entrypoint.sh +++ b/docker-entrypoint.sh @@ -16,7 +16,7 @@ PHP_MEMORY_LIMIT="${PHP_MEMORY_LIMIT:-256M}" UPLOAD_MAX_FILESIZE="${UPLOAD_MAX_FILESIZE:-8M}" # If TRUE, outputs pre and post-change config files, if a /debug folder has also been mounted. -# i.e. - '/opt/docker/configs/littlelink/debug:/debug:rw' +# i.e. - '/opt/docker/configs/linkstack/debug:/debug:rw' # Useful for comparing (and fixing) changes, if necessary. DEBUG="TRUE" @@ -28,7 +28,7 @@ v="$(cat /htdocs/version.json | tr -d '\r\n')" vlen="$((27-${#v}))" echo '+ ------------------------------------------------------------------ +' -printf '| LITTLELINK CUSTOM v%s%*s|\n' "${v}" "$vlen" | tr ' ' " " +printf '| LINKSTACK v%s%*s|\n' "${v}" "$vlen" | tr ' ' " " # + ---------------- + # # | -- HTTPD.CONF -- | # diff --git a/linkstack/.gitignore b/linkstack/.gitignore index e83f092..3652bde 100644 --- a/linkstack/.gitignore +++ b/linkstack/.gitignore @@ -1,4 +1,4 @@ -# Place the LittleLink Custom release files in here. +# Place the LinkStack release files in here. * !.gitignore \ No newline at end of file