Windows Server Setup

Note

SSL certificate generation and Nginx configuration is documented separately. Please see Nginx Setup for more details.

Additionally, you can download a setup package to speed up deployment:

Download Setup Package

This includes:

• Directory structure
• Launch and update scripts
• Example Nginx configuration

---

In a Windows Server environment, only two scripts are required from the root directory:

• update.bat
• launch.bat

update.bat

• Pulls the latest build artifact from the repository
• Verifies and prepares it
• Places it into:

..\bin

launch.bat

• Starts Portweaver and nginx
• Manages their lifecycle
• Must be accessible and allowed through the network

Note

launch.bat is the primary entry point for running the application.

---

Reverse Proxy and SSL

Portweaver runs on an HTTP-only Uvicorn server. SSL cannot be integrated directly into the binary.

To provide secure access:

• nginx is used as a reverse proxy
• HTTPS is terminated at nginx
• Traffic is forwarded internally to Portweaver

Note

This setup ensures secure external access while keeping the internal service simple.

---

Configuration Files

Configuration files are located in:

..\bin\appdata\storage

Caution

These files can be backed up, but must never be moved manually.

The encryption key is derived from the file path. Moving them will permanently break access.

Currently, there is no recovery method outside of Portweaver.

---

Networking and Hosting

By default, Portweaver runs on:

0.0.0.0:8080

This means that by default, it listens on all interfaces over HTTP.

Note

This port and binding address is configurable in the admin settings panel

---

Nginx Configuration

Nginx is responsible for:

• Serving HTTPS on port 443
• Redirecting HTTP (80 → 443)
• Forwarding traffic to Portweaver on 8080

The configuration file is located at:

..\..\nginx\conf\nginx.conf

Note

The nginx configuration file must be saved with UTF-8 encoding.

---

Firewall Configuration

The internal Portweaver port (8080) must not be exposed externally.

Only nginx should be reachable from outside the server.

Required Rules

• Allow:

  • TCP 80 (HTTP → redirect)
  • TCP 443 (HTTPS)

• Block:

  • TCP 8080 (external access)

Caution

Exposing port 8080 externally bypasses TLS and creates a security risk.

---

Environment Setup

Ensure the runtime environment is correctly configured before launching the application.

---

Summary

• Use update.bat to fetch and prepare builds
• Use launch.bat to run Portweaver and nginx
• Do not move encrypted configuration files
• Use nginx for all external traffic
• Restrict direct access to port 8080

This setup ensures a secure and stable deployment in a Windows Server environment.