main
md 48 lines 1.42 KB
Rendered Raw
1 ---
2 title: Prerequisites
3 description: System requirements and prerequisites for running Portal tunnel.
4 ---
5
6 # Prerequisites
7
8 Before installing Portal, make sure your environment meets the following
9 requirements.
10
11 ## System Requirements
12
13 | Requirement | Minimum |
14 |-------------|---------|
15 | OS | Linux (amd64/arm64), macOS (amd64/arm64), Windows (amd64) |
16 | Network | Outbound TCP access for tunnel clients |
17 | Disk | About 10 MB for the binary |
18
19 ## For Tunnel Users
20
21 - A local service running on a TCP port, for example a web server on
22 `localhost:3000`
23 - Internet connectivity to reach a relay server
24
25 No accounts, API keys, billing setup, inbound firewall rules, or browser wallet
26 are required for normal tunnel use.
27
28 ## For Relay Operators
29
30 If you plan to run your own relay server:
31
32 - A server with a public IP address
33 - A domain name with DNS pointing to the server
34 - TLS certificate material, either managed through ACME or manually provided
35 - Open inbound `443/tcp` and `4017/tcp`
36 - Optional UDP and raw TCP transport port ranges
37
38 ## Optional
39
40 - Long random admin token for relay admin access
41 - Ethereum wallet for optional local agent status access
42 - DNS provider account for relay-managed ACME, ECH DNS records, and optional ENS
43 gasless DNS import
44
45 ## Next Steps
46
47 - [Getting Started](/getting-started): install Portal and create your first tunnel
48 - [Wallet and ENS](/wallet-and-ens): understand admin tokens, wallet auth, and ENS gasless DNS