Skip to content
Docs

Linux Server Setup


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 Linux environment, Portweaver is deployed as:

  • A standalone binary (portweaver-server)
  • Running locally on 0.0.0.0:8080
  • Behind nginx reverse proxy for HTTPS handling

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

Directory Structure

Section titled “Directory Structure”

Recommended layout:

~/portweaver/
├── launch.sh
├── update.sh
├── bin/
│   └── portweaver-server
├── scripts/
│   └── fetch-artifact.sh

System Setup

Section titled “System Setup”

Install Dependencies

Section titled “Install Dependencies”
Terminal window
sudo apt update && sudo apt upgrade
sudo apt install nginx tmux htop nano curl jq unzip

Application Setup

Section titled “Application Setup”

Create Application Directory

Section titled “Create Application Directory”
Terminal window
mkdir -p ~/portweaver
cd ~/portweaver

Place Binary

Section titled “Place Binary”
Terminal window
mv portweaver-server ~/portweaver/bin/
chmod +x portweaver-server

Networking & Hosting

Section titled “Networking & Hosting”

Default Application Binding

Section titled “Default Application Binding”

Portweaver runs on:

0.0.0.0:8080

This is intended to be internal-only.

Nginx Reverse Proxy

Section titled “Nginx Reverse Proxy”

Nginx is responsible for:

  • Serving HTTPS (:443)
  • Redirecting HTTP (:80 → 443)
  • Proxying traffic → localhost:8080

Ensure nginx site is configured:

Section titled “Ensure nginx site is configured:”
Terminal window
/etc/nginx/sites-enabled/portweaver.conf

Validate & restart

Section titled “Validate & restart”
Terminal window
sudo nginx -t
sudo systemctl restart nginx

Firewall Rules

Section titled “Firewall Rules”

Ensure:

  • Allow 80/tcp
  • Allow 443/tcp
  • Block 8080/tcp

Example (UFW):

Terminal window
sudo ufw allow 80
sudo ufw allow 443
sudo ufw deny 8080
sudo ufw enable

Running Portweaver

Section titled “Running Portweaver”

Direct Execution

Section titled “Direct Execution”
Terminal window
cd ~/portweaver
chmod +x launch.sh && ./launch.sh

Update Process

Section titled “Update Process”

Requirements

Section titled “Requirements”

GitHub Personal Access Token must be set:

Terminal window
export PAT=your_token_here

Fetch and Prepare Latest Build

Section titled “Fetch and Prepare Latest Build”
Terminal window
chmod +x update.sh && ./update.sh

Optional: Auto-start with systemd

Section titled “Optional: Auto-start with systemd”
Terminal window
sudo nano /etc/systemd/system/portweaver.service
[Unit]
Description=Portweaver Server
After=network.target


[Service]
Type=simple
User=<username>
WorkingDirectory=/home/<username>/portweaver
ExecStart=/home/<username>/portweaver/launch.sh
Restart=always


[Install]
WantedBy=multi-user.target

Enable and start:

Terminal window
sudo systemctl daemon-reexec
sudo systemctl daemon-reload
sudo systemctl enable portweaver
sudo systemctl start portweaver

Debugging & Monitoring

Section titled “Debugging & Monitoring”
Terminal window
systemctl status nginx
sudo nginx -t
tmux attach portweaver