Skip to content

Commit

Permalink
improve README and add warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
unixfox authored Aug 14, 2024
1 parent 4d3cff6 commit bf22ef0
Showing 1 changed file with 43 additions and 22 deletions.
65 changes: 43 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,39 @@
- Provide signature timestamps and player status
- Efficient signature decryption with multi-threaded JavaScript execution

## Building and Running
## Run with Docker (recommended method)

A Dockerfile is included for containerized deployment.

And an official Docker image is available at `quay.io/invidious/inv-sig-helper`: https://quay.io/repository/invidious/inv-sig-helper

### Production

TODO: Follow the official documentation.

### Development

Run the project using docker compose:

```
docker compose up -d
```

Or you can run it manually but not recommended since you won't lock down the container from potential code execution from Google:

1. Build the image:

```
docker build -t inv_sig_helper .
```

2. Run the container:

```
docker run -p 127.0.0.1:12999:12999 inv_sig_helper
```

## Building and Running without Docker

### Prerequisites

Expand All @@ -35,6 +67,16 @@

### Running

#### Warning

We recommend running sig_helper inside a locked down environment like an LXC container or a systemd service where only the strict necessary is allowed.

No guide outside of Docker have been written for this but feel free to send your contribution.

This services runs untrusted code directly from Google.

#### Instructions

The service can run in Unix socket mode (default) or TCP mode:

1. Unix socket mode:
Expand All @@ -53,27 +95,6 @@ The service can run in Unix socket mode (default) or TCP mode:

If no IP:PORT is given, it defaults to `127.0.0.1:12999`.

## Docker

A Dockerfile is included for containerized deployment.

1. Build the image:

```
docker build -t inv_sig_helper .
```

2. Run the container:

```
docker run -p 127.0.0.1:12999:12999 inv_sig_helper
```

Or use Docker Compose:

```
docker compose up
```

## Protocol Format

Expand Down

0 comments on commit bf22ef0

Please sign in to comment.