Skip to content

Commit

Permalink
update README.md with link to releases
Browse files Browse the repository at this point in the history
  • Loading branch information
naim94a committed Jan 21, 2022
1 parent 1ed407c commit dda98e7
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,16 @@ You can read about the protocol research [here](https://abda.nl/posts/introducin
- Experimental HTTP API that allows querying the database for comments by file or function hash.

## Getting Started
### Running the server
Pre-built binaries are not distributed at the moment, you will have to build _lumen_ on your own.
### Binary releases
Release binaries are available at https://github.com/naim94a/lumen/releases/latest.

### Building from source with Rust
1. `git clone https://github.com/naim94a/lumen.git`
2. Get a rust toolchain: https://rustup.rs/
3. `cd lumen`
4. Setup a Postgres database and execute src/schema.sql on it
5. `cargo build --release`

### Docker Method
1. Install `docker-engine` and `docker-compose`.
2. If using a custom TLS certificate, copy the private key (`.p12`/`.pfx` extension) to `./dockershare` and set the key password in `.env` as `PKCSPASSWD`.
Expand Down

0 comments on commit dda98e7

Please sign in to comment.