Voux
Installation

📦 Manual Installation

Install Voux with Node.js.


Requirements

Building / Running

1. Clone the repository

Terminal
git clone https://github.com/QuintixLabs/Voux.git
cd Voux

Make sure you are running Node.js 22. If you use fnm :

Terminal
fnm install 22
fnm use 22
node -v

This should print something like: v22.x.x

2. Install dependencies

Terminal
npm install

3. Create your .env file

Terminal
cp .env.example .env

Read this!

Open .env and set your settings.

If you run Voux on a public domain, set PUBLIC_BASE_URL to your full URL (for example, https://your-domain.com)

If Voux is behind a reverse proxy or tunnel (for example Nginx, Caddy, Cloudflare Tunnel, etc.), also set: TRUST_PROXY=1

4. Start Voux

Terminal
npm run dev

By default, both commands run at: http://localhost:8787. You can change this by setting the PORT value in .env

During development, set NODE_ENV=development in your .env to serve HTML/JS/CSS with no-store caching.

 

Edit on GitHub

Last updated on