diff --git a/shadowbox/README.md b/shadowbox/README.md index 1934f77..87e8400 100644 --- a/shadowbox/README.md +++ b/shadowbox/README.md @@ -1,6 +1,8 @@ shadowbox ========= +[Outline][1] makes it easy to create a VPN server, giving anyone access to the free and open internet. + ## up and running ```bash @@ -9,6 +11,8 @@ $ cd data/certs/ $ openssl req -x509 -nodes -days 365 -newkey rsa:2048 -subj '/CN=localhost' -keyout easypi.key -out easypi.crt $ openssl x509 -in easypi.crt -noout -sha256 -fingerprint | cut -d= -f2 | tr -d : $ docker-compose up -d +$ curl -s -k https://127.0.0.1:8081/easypi/server +$ curl -s -k https://127.0.0.1:8081/easypi/metrics/transfer $ curl -s -k https://127.0.0.1:8081/easypi/access-keys ``` @@ -19,4 +23,17 @@ $ ssh -N -L 8081:localhost:8081 remote-server $ open -a 'Outline Manager' ``` -API: +Paste your installation output: + +```json +{ + "apiUrl": "https://127.0.0.1:8081/easypi", + "certSha256": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" +} +``` + +> `certSha256` is the fingerprint of your ssl certificate. :point_up: + +API Doc: + +[1]: https://getoutline.org/