Installation overview.

Preparation, configuration, and launch in one place. Choose your method and copy the matching files and commands.

Docker ComposeRecommendedDocker run

The recommended method with configuration in a file. The official backup and restore tools use Docker Compose.

01Prepare

What you need

Docker Engine with the Compose plugin, host ports 80 and 443 available, and inbound TCP and UDP traffic allowed on 443
The management UI is available locally at http://localhost:81
A public management origin plus an SMTP host, user, password, and sender address
The database and internal supporting services are included in the appliance
Data is kept in the persistent Docker volume

Create a working directory for RentnerProxy. Run all following commands from this directory.

Create your working directory

mkdir rentnerproxy
cd rentnerproxy

02Configure

Save the Compose file as docker-compose.yml, then the environment example below it as .env. Enter your public HTTPS address for RENTNERPROXY_PUBLIC_ORIGIN and your SMTP settings. Leave the optional proxy CIDRs empty for direct deployments.

Loading installation files…

Open README

03Launch

Loading installation files…

Open README

Start and open

Start RentnerProxy, then open http://localhost:81. Create your first admin account there. Public HTTPS traffic remains available on both TCP and UDP port 443.

After starting

Management binds to 127.0.0.1:81 by default. For a remote server, use the SSH tunnel below and then open http://localhost:8181 on your computer.

ssh -L 8181:127.0.0.1:81 user@server