oxen-io
/
session-open-group-server
mirror of https://github.com/oxen-io/session-open-group-server.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README

This commit is contained in:
Niels Andriesse 2021-03-30 16:26:09 +11:00 committed by GitHub
parent 6f1364f1d3
commit ce15e64150
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -23,7 +23,7 @@ Make sure you're pointing to the right openssl installation (e.g. macOS provides
### Step 2: Build the project
```
cargo build
cargo build --release
```
The Linux Rust installer assumes that you already have a C linker installed. If this is not the case you'll see `error: linker 'cc' not found`. To fix this, run:
@ -36,5 +36,24 @@ sudo apt install build-essential
### Step 3: Run it
```
cargo run --release
./target/release/session-open-group-server
```
**Command line arguments:**
| Command | Default | Description |
| ------------------ |:----------------------:| -------------------------- |
| x25519-public-key | x25519_public_key.pem | Path to X25519 public key |
| x25519-private-key | x25519_private_key.pem | Path to X25519 private key |
| port | 80 | Port to bind to |
| host | 0.0.0.0 | IP to bind to |
If you want to run with TLS enabled:
| Command | Default | Description |
| --------------- |:-------------------:| ----------------------- |
| tls | false | Run in TLS mode |
| tls-certificate | tls_certificate.pem | Path to TLS certificate |
| tls-private-key | tls_private_key.pem | Path to TLS private key |
Note that the default is * not * to run in TLS mode. This is because normally the server communicates through onion requests, eliminating the need for TLS.