Preauth Proxy

[Coverage Shield]

Running the Application

Using Docker

1. Basic Command: Execute the following command to run the container:

   docker run -it --rm -p 3000:3000 timedin/preauth-proxy:latest
   

2. With .env file: If you have a .env file with your environment variables, use the following command:

   docker run --env-file .env -it --rm -p 3000:3000 timedin/preauth-proxy:latest
   

Using Docker Compose

1. Download the docker-compose.yml
2. Set the environment variables to your configuration
3. Run the following command to start the stack:

   docker compose up -d
   

Downloading Prebuilt Version

1. Download the complete build from the release page
2. Extract the files
3. Set your environment variables according to Configuration section
4. Start the server using the following command:

   node ./dist/server/index.js
   

Configuration

Following environment variables are used for config

• JWT_SECRET Random secret for JWT loggedin token (required!)
• USERS JSON-Array of users and passwords allowed (required!) | Example: [{"username":"user1", "password": "pass1"}]
• ROUTES Routes for Proxy (required!) | Example: [{"host":"example.com", "target":"http://localhost:3000"}]
  
  Optional Config:
• HOST Host/Interface of the webserver to listen on (default and when dockerized: 0.0.0.0)
• PORT Port of the webserver for frontend and backend (default 3000)
• DOMAIN Domain for cookie for subdomain wide access (no default)
• COOKIE_SECURE Set cookies to https only (default false)
• COOKIE_SAMESITE Set cookies for cross-origin
• ALLOWED_ORIGINS Semicolon (;) seperated list of CORS Domains OR *