Quick start guide

Here's a minimal version of the steps to run the Secretium on your local machine.

🤔 Can't find the answer here?

Feel free to create an issue or start a discussion in the Secretium project repository. And, of course, we would be happy if you could send a PR with suggestions for improving the docs.

Prepare your local machine

First of all, install Docker with the Compose plugin on your local machine.

Create files for the sensitive data

For the security reasons, create the TXT files with the sensitive data to use them in the Docker Secrets service.

Naming of the TXT files

For the current version of the installation ("quick"), it is highly recommended not to change the file names. They will be used by the automatic installation script to create required project files and running the Secretium container.

For the secret key to encrypt data:

echo "this-is-my-secret-key-123" > secretium_key.txt

DANGER

Please treat it with due consideration! Specify a really complex sequence of numbers, letters and special characters. The length must not be less than 16 characters.

For the master username to login to the dashboard as admin:

echo "this-is-my-master-username" > secretium_master_username.txt

DANGER

Please treat it with due consideration! The minimum length is 4 and the maximum is 16 characters.

For the master password to login to the dashboard as admin:

echo "this-is-my-master-password-123" > secretium_master_password.txt

DANGER

Please treat it with due consideration! Specify a really complex sequence of numbers, letters and special characters. The minimum length is 8 and the maximum is 16 characters.

Run automatic installation script

Run the official quick-start.sh installation script from the Secretium repository:

wget -O - https://raw.githubusercontent.com/secretium/secretium/main/quick-start.sh | bash

This script will automatically:

• Create a minimal docker-compose.yml file.
• Create a folder for the SQLite database.
• Run the docker-compose up -d command to start the container on port 8787.
• Remove the TXT files with the sensitive data after running container.

Start using Secretium

Open your browser, visit http://localhost:8787 and login to the admin dashboard with your master username and master password, which you set in the previous steps.

That's it! 🔥 Your Secretium container is up and running!