Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

readme: update TOC #115

Merged
merged 2 commits into from
Nov 26, 2023
Merged

readme: update TOC #115

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67cf357
readme: update TOC
grische Nov 22, 2023
cf65b32
readme: fix markdown violations
grische Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,18 @@
[![Bazel tests](https://github.com/freifunkMUC/wgkex/actions/workflows/bazel.yml/badge.svg)](https://github.com/freifunkMUC/wgkex/actions/workflows/bazel.yml)

- [WireGuard Key Exchange](#wireguard-key-exchange)
* [Overview](#overview)
+ [Frontend broker](#frontend-broker)
- [POST /api/v1/wg/key/exchange](#post--api-v1-wg-key-exchange)
+ [Backend worker](#backend-worker)
* [Installation](#installation)
* [Configuration](#configuration)
* [Running the broker](#running-the-broker)
* [Client usage](#client-usage)
* [Contact](#contact)

- [Overview](#overview)
- [Frontend broker](#frontend-broker)
- [POST /api/v1/wg/key/exchange](#post-apiv1wgkeyexchange)
- [Backend worker](#backend-worker)
- [Installation](#installation)
- [Configuration](#configuration)
- [Running the broker and worker](#running-the-broker-and-worker)
- [Build using Bazel](#build-using-bazel)
- [Run using Python](#run-using-python)
- [Client usage](#client-usage)
- [Worker](#worker)
- [Contact](#contact)

# WireGuard Key Exchange

Expand Down Expand Up @@ -79,11 +81,11 @@ For further information, please see this [presentation on the architecture](http

## Installation

* TBA
- TBA

## Configuration

* Configuration file
- Configuration file

The `wgkex` configuration file defaults to `/etc/wgkex.yaml` ([Sample configuration file](wgkex.yaml.example)), however
can also be overwritten by setting the environment variable `WGKEX_CONFIG_FILE`.
Expand Down Expand Up @@ -130,6 +132,7 @@ python3 -c 'from wgkex.worker.app import main; main()'
## Client usage

The client can be used via CLI:

```
$ wget -q -O- --post-data='{"domain": "ffmuc_welt","public_key": "o52Ge+Rpj4CUSitVag9mS7pSXUesNM0ESnvj/wwehkg="}' --header='Content-Type:application/json' 'http://127.0.0.1:5000/api/v1/wg/key/exchange'
{
Expand All @@ -138,6 +141,7 @@ $ wget -q -O- --post-data='{"domain": "ffmuc_welt","public_key": "o52Ge+Rpj4CUS
```

Or via python:

```python
import requests
key_data = {"domain": "ffmuc_welt","public_key": "o52Ge+Rpj4CUSitVag9mS7pSXUesNM0ESnvj/wwehkg="}
Expand Down Expand Up @@ -169,7 +173,6 @@ sudo ip link set wg-welt up
sudo ip link set vx-welt up
```


## Contact

[Freifunk Munich Mattermost](https://chat.ffmuc.net)
Loading