Marzneshin

Get Marzneshin

Clone this project and install the dependencies (you’d need Python >= 3.10)

git clone https://github.com/marzneshin/Marzneshin
cd Marzneshin/
wget -qO- https://bootstrap.pypa.io/get-pip.py | python3 -
python3 -m pip install -r requirements.txt

Alternatively, to run in an isolated environment you can create a virtual environment

Build the dashboard

To install dashboard dependencies and build the dashboard:

make dashboard-deps
make dashboard-build

note that you’ll need pnpm and npm installed.

Setup marzneshin-cli

If you want to use marzneshin-cli, you should link it to a file in your $PATH, make it executable, and install the auto-completion:

sudo ln -s $(pwd)/marzneshin-cli.py /usr/bin/marzneshin-cli
sudo chmod +x /usr/bin/marzneshin-cli
marzneshin-cli completion install

Configuration

Now it’s time for configuration

Make a copy of .env.example file, take a look and edit it using a text editor like nano.

cp .env.example .env
nano .env

Check out marzneshin configuration guide for more information

Generate the database

Currently to generate the db, you should run

alembic upgrade head

Startup

Eventually, launch the application using one of the below commands

By default the app will be run on http://localhost:8000/dashboard. You can configure it using changing the UVICORN_HOST and UVICORN_PORT environment variables.

Configuring tls

Refer to running behind nginx