Exposing Perplexica to a Network

This guide explains how to make Perplexica available over a network using the built-in Nginx reverse proxy.

Accessing Perplexica Over a Network

Basic Access

With the Nginx reverse proxy, Perplexica is automatically accessible from any device on your network:

Start Perplexica using Docker Compose:
```
docker compose up -d
```
Find your server's IP address:
- Windows: ipconfig in Command Prompt
- macOS: ifconfig | grep "inet " in Terminal
- Linux: ip addr show | grep "inet " in Terminal
Access Perplexica from any device on your network:
```
http://YOUR_SERVER_IP:8080
```

Domain Configuration

If you have a domain name, you can point it to your server:

Configure your domain's DNS settings to point to your server IP
Access Perplexica via:
```
http://your-domain.com:8080
```

Advanced Configuration

Custom Port

If you need to use a different port instead of the default 8080:

Modify the docker-compose.yaml file:

nginx:
  ports:
    - "YOUR_CUSTOM_PORT:80"

Restart the containers:

docker compose down && docker compose up -d

SSL/HTTPS Configuration

For secure HTTPS access:

Modify the Nginx configuration to include SSL:

# In nginx.conf
server {
  listen 80;
  listen 443 ssl;

  ssl_certificate /path/to/certificate.crt;
  ssl_certificate_key /path/to/private.key;

  # Rest of configuration...
}

Update the Docker volume to include your certificates:

nginx:
  volumes:
    - ./nginx.conf:/etc/nginx/nginx.conf:ro
    - ./ssl:/path/to/ssl:ro

Restart the containers:

docker compose down && docker compose up -d

Or just use another reverse proxy on top of this one...

Troubleshooting

If you encounter issues accessing Perplexica over your network:

Firewall Settings: Ensure port 8080 (or your custom port) is allowed in your firewall
Docker Network: Check if Docker's network settings allow external connections:
```
docker network inspect perplexica_perplexica-network
```
Nginx Logs: Check for any connection issues:
```
docker logs perplexica-nginx-1
```
Direct Access: Verify if you can access the services directly:
- Frontend: http://YOUR_SERVER_IP:3000
- Backend: http://YOUR_SERVER_IP:3001

2.4 KiB Raw Blame History