prabhjeetme/openjanus repository overview

⁠OpenJanus - All in One Nginx Server

An open-source, containerized infrastructure stack combining OpenResty, automatic SSL (registration & renewal), and a built-in WireGuard VPN to securely expose public and private endpoints with minimal configuration and operational overhead.

⁠Support This Project

If you find this project helpful, consider supporting my work.

⁠Key Capabilities

• Automatic SSL: Registration & renewal using certbot (acme-challenge)
• Automatic VPN: WireGuard to register peers & route traffic to containers with VPN private IP.
• OpenResty: Provides additional functionality over Nginx.
• Nginx: All functionalities provided by Nginx.

⁠Version Compatibility

⁠Builtin Features

1. Preconfigured security headers in http block. These headers will be inherited in all of the server blocks. If any application requires a different value for any header, it can be overwritten in server block of itself. See Overwrite header in this example⁠
2. Default error pages. Container comes with predefined error pages for 30x, 40x & 50x. Error pages can be overridden in html⁠ directory.
3. Best possible SSL & DHparam Nginx configurations (see nginx.conf⁠).

⁠Examples

1. Serving custom 50x page: Configuration to serve custom 50x page here⁠.
2. Serving custom 403 page: Configuration to serve custom 403 page here⁠.
3. One line configuration to do above 2 & override all error pages here⁠.
4. Override default headers: This⁠ shows how to override default headers.
5. Setting SSL: SSL setup is demonstrated in this⁠ example.
6. Stream TCP connection: To stream TCP connection, this example⁠ should be helpful (make sure stream port is mapped to host machine).

⁠Docker Compose

services:
  openjanus:
    image: prabhjeetme/openjanus:latest
    container_name: openjanus
    restart: always
    cap_add:
      - NET_ADMIN
    devices:
      - /dev/net/tun:/dev/net/tun
    environment:
      - CB_TESTING=0
      - [email protected]
      - CB_DOMAINs=example.com app1.example.com
      - WG_PEERS=phone:10.13.13.2,tablet:10.13.13.3
      - VPN_ENDPOINT=vpn.example.com
      - VPN_PORT=51820
      - SERVER_PUBLIC_IP=xx.xx.xx.xx
    ports:
      - "80:80"
      - "443:443"
      - "51820:51820/udp"
    volumes:
      - ./configs/conf:/etc/openjanus/conf:ro # Nginx config
      - ./configs/stream:/etc/openjanus/stream:ro # Nginx steam config
      - ./volumes/letsencrypt:/etc/letsencrypt # SSL certificates
      - ./volumes/openjanus/ssl:/etc/openjanus/ssl # Stores DH param
      - ./volumes/openjanus/var:/var/lib/openjanus # Stores run state
      - ./volumes/wireguard:/etc/wireguard # VPN configs

⁠Environment Variables

⁠Volumes

⁠Ports

⁠Deployment

1. Use docker-compose.yml⁠ as the base template.
2. Update environment variables⁠ for your site.
3. It is necessary to mount directories (mentioned in docker-compose.yml⁠) for persistence.
4. Put your nginx configs in conf & stream directory.
5. Make sure you have created records for all DNS mentioned in CB_DOMAINs & VPN_ENDPOINT (and are propagated).
6. Make sure VPN_PORT is allowed on firewall.
7. Run the container using docker compose up -d.

For more information visit OpenJanus Repository⁠ on GitHub.