elestio4test/shlink-app repository overview

⁠

⁠Shlink, verified and packaged by Elestio

A better community platform for the modern web.

Shlink⁠ is a self-hosted URL shortener which provides both a REST and a CLI interface to interact with it.

Deploy a fully managed Shlink⁠ on elest.io⁠ Free & Source Available Messaging Platform for Marketing, Support & Sales .

⁠Why use Elestio images?

• Elestio stays in sync with updates from the original source and quickly releases new versions of this image through our automated processes.
• Elestio images provide timely access to the most recent bug fixes and features.
• Our team performs quality control checks to ensure the products we release meet our high standards.

⁠Usage

⁠Git clone

You can deploy it easily with the following command:

git clone https://github.com/elestio-examples/shlink.git

Copy the .env file from tests folder to the project directory

cp ./tests/.env ./.env

Edit the .env file with your own values.

Run the project with the following command

docker-compose up -d

You can access the Web UI at: http://your-domain:2081

⁠Docker-compose

Here are some example snippets to help you get started creating a container.

    version: '3'
    services:

        shlink_db_mysql:
        image: mysql:latest
        restart: always
        environment:
            - MYSQL_DATABASE=shlink
            - MYSQL_PASSWORD=${ADMIN_PASSWORD}
            - MYSQL_ROOT_PASSWORD=${ADMIN_PASSWORD}
        volumes:
            - ./data/infra/database:/var/lib/mysql
    
        shlink_app:
        image: elestio4test/shlink:${SOFTWARE_VERSION_TAG}
        ports:
            - "172.17.0.1:2080:8080"
        environment:
            - DEFAULT_DOMAIN=${DOMAIN}:2080
            - IS_HTTPS_ENABLED=true
            - DB_DRIVER=mysql
            - DB_USER=root
            - DB_PASSWORD=${ADMIN_PASSWORD}
            - DB_HOST=shlink_db_mysql
            - DB_PORT=3306 
        restart: always
        depends_on:
            - shlink_db_mysql

        shlink_web_client:
        image: shlinkio/shlink-web-client:${SOFTWARE_VERSION_TAG}
        restart: always
        user: 0:0
        ports:
            - "172.17.0.1:2081:80"
        environment:
            - SHLINK_SERVER_URL=https://${DOMAIN}:2080
            - SHLINK_SERVER_NAME=Main server
            - SHLINK_SERVER_API_KEY=

⁠Environment variables

⁠Maintenance

⁠Logging

The Elestio Shlink Docker image sends the container logs to stdout. To view the logs, you can use the following command:

docker-compose logs -f

To stop the stack you can use the following command:

docker-compose down

⁠Backup and Restore with Docker Compose

To make backup and restore operations easier, we are using folder volume mounts. You can simply stop your stack with docker-compose down, then backup all the files and subfolders in the folder near the docker-compose.yml file.

Creating a ZIP Archive For example, if you want to create a ZIP archive, navigate to the folder where you have your docker-compose.yml file and use this command:

zip -r myarchive.zip .

Restoring from ZIP Archive To restore from a ZIP archive, unzip the archive into the original folder using the following command:

unzip myarchive.zip -d /path/to/original/folder

Starting Your Stack Once your backup is complete, you can start your stack again with the following command:

docker-compose up -d

That's it! With these simple steps, you can easily backup and restore your data volumes using Docker Compose.

⁠Links

• Shlink documentation⁠

• Shlink Github repository⁠

• Elestio/Shlink Github repository⁠