# Running ORLY Relay Remotely

## Quick Start

### 1. Pull the Image
```bash
docker pull silberengel/next-orly:v0.58.5
```

### 2. Run with Docker Run
```bash
docker run -d \
  --name orly-relay \
  --restart always \
  -p 3334:3334 \
  -v /var/lib/orly:/data \
  -e ORLY_DATA_DIR=/data \
  -e ORLY_LISTEN=0.0.0.0 \
  -e ORLY_PORT=3334 \
  -e ORLY_LOG_LEVEL=info \
  silberengel/next-orly:v0.58.5
```

### 3. Or Use Docker Compose

Create a `docker-compose.yml`:
```yaml
version: '3.8'

services:
  orly-relay:
    image: silberengel/next-orly:v0.58.5
    container_name: orly-relay
    restart: always
    ports:
      - "3334:3334"
    volumes:
      - /var/lib/orly:/data
    environment:
      - ORLY_DATA_DIR=/data
      - ORLY_LISTEN=0.0.0.0
      - ORLY_PORT=3334
      - ORLY_LOG_LEVEL=info
```

Then run:
```bash
docker-compose up -d
```

## Configuration Options

### Basic Configuration
- `ORLY_DATA_DIR` - Data directory (default: `/data`)
- `ORLY_LISTEN` - Listen address (default: `0.0.0.0`)
- `ORLY_PORT` - Port number (default: `3334`)
- `ORLY_LOG_LEVEL` - Log level: `debug`, `info`, `warn`, `error`

### Advanced Configuration
- `ORLY_ADMINS` - Comma-separated list of admin npub keys
- `ORLY_OWNERS` - Comma-separated list of owner npub keys
- `ORLY_ACL_MODE` - ACL mode: `open`, `follows`, `managed`
- `ORLY_SPIDER_MODE` - Spider mode: `off`, `follows`, `all`
- `ORLY_RELAY_URL` - Public relay URL (for metadata)
- `ORLY_MAX_CONNECTIONS` - Max concurrent connections (default: 1000)
- `ORLY_MAX_EVENT_SIZE` - Max event size in bytes (default: 65536)

## Useful Commands

### View Logs
```bash
docker logs -f orly-relay
```

### Stop Container
```bash
docker stop orly-relay
```

### Start Container
```bash
docker start orly-relay
```

### Restart Container
```bash
docker restart orly-relay
```

### Remove Container
```bash
docker rm -f orly-relay
```

### Update to Latest Version
```bash
docker pull silberengel/next-orly:v0.58.5
docker stop orly-relay
docker rm orly-relay
# Then run your docker run or docker-compose command again
```

## Behind a Reverse Proxy

If running behind nginx/Caddy/etc, bind to localhost only:
```bash
docker run -d \
  --name orly-relay \
  --restart always \
  -p 127.0.0.1:3334:3334 \
  -v /var/lib/orly:/data \
  -e ORLY_DATA_DIR=/data \
  -e ORLY_LISTEN=0.0.0.0 \
  -e ORLY_PORT=3334 \
  silberengel/next-orly:v0.58.5
```

## Data Persistence

Data is stored in `/var/lib/orly` on the host (or whatever path you mount).
To backup:
```bash
tar -czf orly-backup-$(date +%Y%m%d).tar.gz /var/lib/orly
```

To restore:
```bash
tar -xzf orly-backup-YYYYMMDD.tar.gz -C /
```