session-open-group-server/README.md

39 lines
940 B
Markdown
Raw Normal View History

2021-03-25 03:20:44 +01:00
![example workflow](https://github.com/nielsandriesse/session-open-group-server/actions/workflows/build.yml/badge.svg)
2021-03-05 05:13:31 +01:00
2021-03-15 05:41:24 +01:00
## Requirements
2021-03-15 05:41:24 +01:00
| Dependency | Version |
| ------------- |:-------------:|
| rustup | 1.50.0 |
| openssl | 1.1.1 |
## Setup
### Step 1: Generate an X25519 key pair
```
openssl genpkey -algorithm x25519 -out x25519_private_key.pem
openssl pkey -in x25519_private_key.pem -pubout -out x25519_public_key.pem
```
2021-03-15 05:41:24 +01:00
Make sure you're pointing to the right openssl installation (e.g. macOS provides an old default implementation that doesn't have the X25519 algorithm).
2021-03-18 06:39:14 +01:00
### Step 2: Build the project
2021-03-05 05:13:31 +01:00
2021-03-09 04:22:09 +01:00
```
cargo build
2021-03-15 05:41:24 +01:00
```
2021-03-15 05:43:17 +01:00
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:
2021-03-15 05:41:24 +01:00
```
apt update
sudo apt install build-essential
```
2021-03-18 06:39:14 +01:00
### Step 3: Run it
2021-03-15 05:41:24 +01:00
```
cargo run --release
2021-03-09 04:22:09 +01:00
```