From bb3a3dda345a9d42bf75ab825b7f4a954e7db70c Mon Sep 17 00:00:00 2001 From: Yarmo Mackenbach Date: Tue, 4 May 2021 11:42:28 +0200 Subject: [PATCH] Minor improvements --- content/guides/managing-proofs-key.md | 35 ----------------------- content/guides/managing-proofs-listing.md | 2 -- content/guides/self-hosting-keyoxide.md | 29 +++++++++++++++++-- 3 files changed, 26 insertions(+), 40 deletions(-) delete mode 100644 content/guides/managing-proofs-key.md diff --git a/content/guides/managing-proofs-key.md b/content/guides/managing-proofs-key.md deleted file mode 100644 index 854d270..0000000 --- a/content/guides/managing-proofs-key.md +++ /dev/null @@ -1,35 +0,0 @@ -# Listing Proofs using GnuPG - -Let's list the identity proofs stored in our OpenPGP keys. - -## Listing notations in GnuPG - -First, edit the key (make sure to replace FINGERPRINT): - -``` -gpg --edit-key FINGERPRINT -``` - -List detailed preferences: - -``` -showpref -``` - -You should now see your key details, uid, and proofs assigned to your keys: - -``` -[ultimate] (1). Your Name - Cipher: AES256, AES192, AES, 3DES - Digest: SHA512, SHA384, SHA256, SHA1 - Compression: ZLIB, BZIP2, ZIP, Uncompressed - Features: MDC, Keyserver no-modify - Notations: proof@metacode.biz=https://gist.github.com/youruser/somehash - proof@metacode.biz=dns:yourdomain.org?type=TXT -``` - -Exit gpg: - -``` -quit -``` diff --git a/content/guides/managing-proofs-listing.md b/content/guides/managing-proofs-listing.md index 7180710..854d270 100644 --- a/content/guides/managing-proofs-listing.md +++ b/content/guides/managing-proofs-listing.md @@ -6,8 +6,6 @@ Let's list the identity proofs stored in our OpenPGP keys. First, edit the key (make sure to replace FINGERPRINT): -``` -` ``` gpg --edit-key FINGERPRINT ``` diff --git a/content/guides/self-hosting-keyoxide.md b/content/guides/self-hosting-keyoxide.md index b9d168a..6c62c04 100644 --- a/content/guides/self-hosting-keyoxide.md +++ b/content/guides/self-hosting-keyoxide.md @@ -1,7 +1,30 @@ # Self-hosting Keyoxide -Though it's not a fully supported use case yet, anyone can take the [source code](https://codeberg.org/keyoxide/web) and put it on their own server. The idea is that [Keyoxide.org](https://keyoxide.org) is not special in itself. After all, all the heavy lifting is done by the browser. So the role of any individual Keyoxide server is to get the tool in the hands of the end user. +Self-hosting Keyoxide is an important aspect of the project. Users need to trust the Keyoxide instance they're using to reliably verify identities. Making Keyoxide itself decentralized means no one needs to trust a central server. If a friend or family member is hosting a Keyoxide instance, it becomes much easier to trust the instance! -The few supporting roles the server has can easily be performed by any other (PHP) server. +## Docker -So if you like the project but perhaps are mistrusting of servers of others, especially when it comes to keypairs, here's the [source code](https://codeberg.org/keyoxide/web) and put it on your own server. Thanks for using the project! +- Run `docker run -d -p 3000:3000 keyoxide/keyoxide:stable` + +### Configuration + +- Add environment variables to the docker command: + `docker run -d -p 3000:3000 -e PROXY_HOSTNAME=proxy.domain.tld keyoxide/keyoxide:stable` + +## Without Docker + +- Fetch the [source code](https://codeberg.org/keyoxide/web) and put the files on your server +- Run `yarn` or `npm install` to install the dependencies +- Run `yarn run start` or `npm run start` to start the server at `http://localhost:3000` +- Point your reverse proxy to `http://localhost:3000` + +### Configuration + +- Add a `.env` file to the root directory of the source code: + +``` +# .env file + +# Enable the use of a proxy (replace with your proxy server domain) +PROXY_HOSTNAME=proxy.domain.tld +```