Nginx
Set
TRUST_PROXY=trueAdd TRUST_PROXY=true to your .env or docker-compose.yml, and set BASE_URL to the public address. Without it, PLANKA sees the address of the proxy for every user: they all share one sign-in limit, and Fail2ban would ban the proxy. Make sure PLANKA cannot be reached without going through the proxy.
The samples use the port of a manual installation, 1337. The stock docker-compose.yml publishes port 3000 instead.
Configuration Sample
Below is an example configuration for running PLANKA behind an Nginx reverse proxy. Replace <domain> with your actual domain name, and be sure to configure SSL separately (e.g., via Let's Encrypt).
upstream planka {
server localhost:1337;
keepalive 32;
}
server {
listen 80;
listen [::]:80;
server_name <domain>;
access_log /var/log/nginx/planka-access.log;
error_log /var/log/nginx/planka-error.log error;
# Make sure to allow socket.io connections
location ~* \.io {
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
client_max_body_size 50M;
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Frame-Options SAMEORIGIN;
proxy_buffers 256 16k;
proxy_buffer_size 16k;
client_body_timeout 60;
send_timeout 300;
lingering_timeout 5;
proxy_connect_timeout 1d;
proxy_send_timeout 1d;
proxy_read_timeout 1d;
proxy_pass http://planka;
}
location / {
client_max_body_size 50M;
proxy_set_header Connection "";
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Frame-Options SAMEORIGIN;
proxy_buffers 256 16k;
proxy_buffer_size 16k;
proxy_read_timeout 600s;
proxy_cache_revalidate on;
proxy_cache_min_uses 2;
proxy_cache_use_stale timeout;
proxy_cache_lock on;
proxy_http_version 1.1;
proxy_pass http://planka;
}
}
Notes
X-Forwarded-Foris set to$remote_addron purpose. PLANKA trusts this header, so forwarding what the client sent would let it fake its address and get around the sign-in limits. If there is another proxy in front of Nginx, configurereal_ipto resolve the client address first.- SSL is not included in this configuration. For production, it is strongly recommended to use HTTPS.
- Consider redirecting HTTP to HTTPS and setting up SSL with Let's Encrypt and
certbot.