Installing OPN_alias

Let’s get OPN_alias running!

Get and Set the Config Files

Copy the example env file to .env Edit the file, we’ll need to change some settings for you. There’s a few, but we’ll deal with them one at a time:

	MARIADB_USERNAME=<any username you like>  
	MARIADB_PASSWORD=<any password you like>  
	MARIADB_DATABASE=opn_alias
	REDIS_URL=redis://redis:6379/0  
	SECRET_KEY=<< long secret key >>  
	ENCRYPTION_KEY=<< 32 char, url safe string (use a generator, 32 chars, upper,lower,numbers>>

Deal with them one at a time:

Line Meaning Suggestion
MARIADB_USERNAME Database Username opn_alias
MARIADB_PASSWORD Database Password Anything you want
MARIADB_DATABASE Database Name opn_alias
REDIS_URL Redis URL (Leave as is)
FLASK_APP Point to the app to run. Don’t change this! opn_alias.app
SECRET_KEY Browser Data Encryption See below
ENCRYPTION_KEY Database Entry Encryption See below

Secret and Encryption Keys

During the early releases, there’s a limitation on these:

  • Exactly 32 Characters long
  • Uppercase, lowercase and numbers only Remember when you put them in, you don’t need quote marks around them, just the plain string

You should end up with something like this:

![[images/Pasted image 20251024045730.png]]

Starting it Up

Almost there!

Just run

docker compose up -d

And let it all come up.

Once it’s working, you can access it at https://localhost:8000

If you get a page like this:

You’re all set to start configuring…

Last modified October 24, 2025: Initial seed (416ac63)