Nyx's stuff

Appearance

Deploying the nClean server ​

WARNING

Deploying the nClean server on Windows is not supported, I highly recommend using a Linux-based server for production deployments AND using Docker.

Bare metal Linux installation ​

Python requirements

nClean requires Python 3.10 or higher, please install it using the package manager for your distro.

  1. Clone the nClean repository from GitHub
bash
git clone https://github.com/nyxiereal/nClean.git
cd nClean
  1. Install uv

uv installation method

I recommend installing uv from your package manager instead of running the script below

bash
curl -LsSf https://astral.sh/uv/install.sh | sh
  1. Install the dependencies

TIP

Please adjust the activate file to the shell you're currently using!

bash
uv venv WebUI
cd WebUI
source bin/activate
uv pip install -r requirements.txt
  1. Start the gunicorn server

WARNING

Gunicorn isn't available on Windows, please use WSL or a Linux-based server.

bash
uv run gunicorn -w 4 -b 0.0.0.0:5002 main:app

Deploying in Docker ​

  1. Clone the nClean repository from GitHub
bash
git clone https://github.com/nyxiereal/nClean.git
cd nClean
  1. Build the Docker image
bash
docker buildx build -t nclean .
  1. Run the Docker container
bash
docker run -d -p 5002:5002 nclean --name nclean
  1. Log into the admin panel for nClean using the admin/admin user credentials, then restart the server and log in again.