elestio/hoppscotch-sh-admin repository overview

⁠

⁠Hoppscotch, verified and packaged by Elestio

Hoppscotch⁠ is an open source API development ecosystem.

Deploy a fully managed Hoppscotch⁠ on elest.io⁠ if you want automated backups, reverse proxy with SSL termination, firewall, automated OS & Software updates, and a team of Linux experts and open source enthusiasts to ensure your services are always safe, and functional.

⁠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/hoppscotch.git

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

cp ./tests/.env ./.env

Edit the .env file with your own values.

Create data folders with correct permissions

mkdir -p ./pgdata
chown -R 1000:1000 ./pgdata

Run the project with the following command

docker-compose up -d
./scripts/postInstall.sh

You can access the Web UI at: http://your-domain:3130 You can access the Admin UI at: http://your-domain:3100

⁠Docker-compose

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

version: "3.3"

services:
    hoppscotch-backend:
        image: elestio/hoppscotch-backend:latest
        env_file:
            - ./.env
        restart: always
        environment:
            - DATABASE_URL=postgresql://postgres:${ADMIN_PASSWORD}@hoppscotch-db:5432/hoppscotch?connect_timeout=300
            - PORT=8080
        depends_on:
            - hoppscotch-db
        ports:
            - "172.17.0.1:3170:8080"

    hoppscotch-app:
        image: elestio/hoppscotch-app:latest
        env_file:
            - ./.env
        depends_on:
            - hoppscotch-backend
        ports:
            - "172.17.0.1:3130:3000"

    hoppscotch-sh-admin:
        image: elestio/hoppscotch-sh-admin:latest
        env_file:
            - ./.env
        depends_on:
            - hoppscotch-backend
        ports:
            - "172.17.0.1:3100:3100"

    hoppscotch-db:
        image: elestio/postgres:15
        ports:
            - "172.17.0.1:5282:5432"
        environment:
        POSTGRES_USER: postgres
        POSTGRES_PASSWORD: ${ADMIN_PASSWORD}
        POSTGRES_DB: hoppscotch
        volumes:
            - ./pgdata:/var/lib/postgresql/data/

⁠Environment variables

⁠Maintenance

⁠Logging

The Elestio Hoppscotch 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

• Hoppscotch documentation⁠

• Hoppscotch Github repository⁠

• Elestio/Hoppscotch Github repository⁠