elestio/chiefonboarding repository overview

⁠

⁠ChiefOnboarding, verified and packaged by Elestio

ChiefOnboarding⁠ help you structure your onboarding process for IT, HR, managers, buddies, and, of course, your new hires.

Deploy a fully managed ChiefOnboarding⁠ 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/chiefonboarding.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 ./data
chown -R 1000:1000 ./data

Run the project with the following command

docker-compose up -d

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

⁠Docker-compose

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

version: "3.3"

services:
    db:
        image: postgres:14
        restart: always
        volumes:
            - ./data:/var/lib/postgresql/data
        environment:
            - POSTGRES_DB=chiefonboarding
            - POSTGRES_USER=postgres
            - POSTGRES_PASSWORD=postgres

    app:
        image: elestio/chiefonboarding:latest
        restart: always
        ports:
            - "172.17.0.1:8888:8000"
        environment:
            - SECRET_KEY=${SECRET_KEY}
            - DATABASE_URL=postgres://postgres:postgres@db:5432/chiefonboarding
            - ALLOWED_HOSTS=${DOMAIN}
            - ACCOUNT_EMAIL=${ADMIN_EMAIL}
            - ACCOUNT_PASSWORD=${ADMIN_PASSWORD}
            - ANYMAIL=${ANYMAIL}
            - DEFAULT_FROM_EMAIL=${DEFAULT_FROM_EMAIL}
            - EMAIL_HOST=${EMAIL_HOST}
            - EMAIL_PORT=${EMAIL_PORT}
            - EMAIL_HOST_USER=${EMAIL_HOST_USER}
            - EMAIL_HOST_PASSWORD=${EMAIL_HOST_PASSWORD}
            - EMAIL_USE_TLS=${EMAIL_USE_TLS}
            - EMAIL_USE_SSL=${EMAIL_USE_SSL}
        depends_on:
            - db

⁠Environment variables

⁠Maintenance

⁠Logging

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

• ChiefOnboarding documentation⁠

• ChiefOnboarding Github repository⁠

• Elestio/chiefonboarding Github repository⁠