Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kokseen1 committed Jun 1, 2023
1 parent 4bd2af7 commit e19b1a3
Showing 1 changed file with 28 additions and 9 deletions.
37 changes: 28 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,49 @@ sudo iptables -A OUTPUT -p tcp --tcp-flags RST RST -s <local address> -j DROP
pip3 install toori-server --no-binary :all:
```

## Usage
## Deploying with Docker

Run with root permissions:
Instead of installing toori-server on the host, it can alternatively be deployed as a Docker container.

Pull from GHCR:

```shell
iro <port>
sudo docker pull ghcr.io/kokseen1/toori-server:latest
```

Example with HTTPS:
Run the container:

```shell
iro 443 -c "/etc/letsencrypt/live/toori.server/"
sudo docker run -d --cap-add=NET_ADMIN -p 80:80 ghcr.io/kokseen1/toori-server
```

### Docker
#### HTTPS

Build the image:
To deploy with HTTPS, modify `docker-entrypoint.sh` to point to the certs directory:

```shell
sudo docker build . -t toori-server
iro 443 -c /path/to/certs/
# iro 80
```

Run the container:

```shell
sudo docker run -d --cap-add=NET_ADMIN -p 80:80 toori-server
docker run -d -v /etc/letsencrypt:/path/to/certs --cap-add=NET_ADMIN -p 443:443 ghcr.io/kokseen1/toori-server
```

## Usage

Run with root permissions:

```shell
iro <port>
```

Example with HTTPS:

```shell
iro 443 -c "/etc/letsencrypt/live/toori.server/"
```


0 comments on commit e19b1a3

Please sign in to comment.