Skip to content

Changes

Page history
Update Usage authored by Michael Westergaard's avatar Michael Westergaard
Hide whitespace changes
Inline Side-by-side
Usage.md
View page @ a4c7e3e6
## Central use ##
The central installation of VKV allows a very low barrier to entry for experimenting with VKV without installing anything. This version of VKV does not allow uploading your own data, so it is only possible to experiment with the provided test data. To use your own data, check the decentral use section below.
The central installation of VOLT allows a very low barrier to entry for experimenting with VOLT without installing anything. This version of VOLT does not allow uploading your own data, so it is only possible to experiment with the provided test data. To use your own data, check the decentral use section below.
### Usage ###
- In a browser, navigate to [frontend.production.vkv.kik-v.ocs.nu](https://frontend.production.vkv.kik-v.ocs.nu) (or click the link)
- In a browser, navigate to [frontend.acceptence.volt.kik-v.ocs.nu](https://frontend.acceptence.volt.kik-v.ocs.nu) (or click the link)
## Decentral use ##
This is the preferred way to use VKV in most cases, and is also the only way to use VKV with your own data.
This is the preferred way to use VOLT in most cases, and is also the only way to use VOLT with your own data.
### Prerequisites ###
......@@ -18,7 +18,7 @@ This is the preferred way to use VKV in most cases, and is also the only way to
- Execute
```
docker run -tp 8080:80 -p 8443:443 registry.istandaarden.nl/kik-v/vkv/frontend:<version>
docker run -tp 8080:80 -p 8443:443 registry.istandaarden.nl/kik-v/volt/frontend:<version>
```
where ``<version>`` is the desired version or ``latest`` to automatically start the latest version.
......@@ -28,7 +28,7 @@ where ``<version>`` is the desired version or ``latest`` to automatically start
### Frontend configuration ###
The frontend is designed to be usable without any configuration when using the application the simplest scenario of a sinhle user running the application on their own computer. For other scenarios, like running the application shared among multiple users, some configuration is needed.
The frontend is designed to be usable without any configuration when using the application the simplest scenario of a single user running the application on their own computer. For other scenarios, like running the application shared among multiple users, some configuration is needed.
#### TLS Configuration ####
......@@ -66,7 +66,7 @@ This option is for more advanced users with more specific needs (e.g., if you mu
| `VKV_KEY` | | Base64 encoded PEM private key | T3 |
| `VKV_CERT_CHAIN` | | Base64 encoded PEM certificate corresponding to the above key and host name. Should also preferably contain intermediate certificates until a trusted root. | T3 |
Note that while PEM certificates/keys contain base64-encoded data, the values provided to VKV must be base-64 encoded again so that after base64 decoding it will generate a valid certificate/key file.
Note that while PEM certificates/keys contain base64-encoded data, the values provided to VOLT must be base-64 encoded again so that after base64 decoding it will generate a valid certificate/key file.
#### Application location overview ####
......@@ -83,29 +83,29 @@ In the default configuartion, you do not *have* to bind any volumes, the applica
#### Examples ####
##### Improved security for a single user #####
To run the VKV frontend using TLS scenario T1 (self-signed certificate), storing certificates in the current folder on the host system, execute:
To run the VOLT frontend using TLS scenario T1 (self-signed certificate), storing certificates in the current folder on the host system, execute:
```
docker run -tp 8080:80 -p 8443:443 \
-e VKV_HOSTNAME='localhost' \
-v $( pwd ):/tls \
registry.istandaarden.nl/kik-v/vkv/frontend:<version>
registry.istandaarden.nl/kik-v/volt/frontend:<version>
```
Note: the `$( pwd )` syntax works on unix-like systems (Linux, Max OS X); on Windows provide the full path, e.g., `d:\\tls`.
##### Imnproved security using Let's Encrypt, faster start-up, and persistence of uploads between restarts #####
To run the VKV frontend using TLS scenario T2 (Let's Encrypt certificate), storing certificates in a `tls` folder under the current folder, storing uploaded data in `data/uploads`, and storing updates from the central service in `data/central`, execute:
To run the VOLT frontend using TLS scenario T2 (Let's Encrypt certificate), storing certificates in a `tls` folder under the current folder, storing uploaded data in `data/uploads`, and storing updates from the central service in `data/central`, execute:
```
docker run -tp 8080:80 -p 8443:443 \
-e VKV_HOSTNAME='vkv.example.com' \
-e VKV_EMAIL='vkv@example.com' \
-e VKV_HOSTNAME='volt.example.com' \
-e VKV_EMAIL='volt@example.com' \
-v $( pwd )/tls:/tls \
-v $( pwd )/data/uploads:/data/ephemeral \
-v $( pwd )/data/central:/data/persistent \
registry.istandaarden.nl/kik-v/vkv/frontend:<version>
registry.istandaarden.nl/kik-v/volt/frontend:<version>
```
Note: the `$( pwd )` syntax works on unix-like systems (Linux, Max OS X); on Windows provide the full path, e.g., `d:\\tls`.
......@@ -117,7 +117,7 @@ docker run -tp 8080:80 -p 8443:443 \
-v $( pwd )/tls:/tls \
-v $( pwd )/data/uploads:/data/ephemeral \
-v $( pwd )/data/central:/data/persistent \
registry.istandaarden.nl/kik-v/vkv/frontend:<version>
registry.istandaarden.nl/kik-v/volt/frontend:<version>
```
As long as the `/tls` folder is bound to the same host path, VKV can figure out how to renew the certificate as needed. If the VKV installation changes external name, just execute it with the new host name in `VKV_HOSTNAME` and the appropriate email in `VKV_EMAIL` to request and use a new certificate instead.
As long as the `/tls` folder is bound to the same host path, VOLT can figure out how to renew the certificate as needed. If the VKV installation changes external name, just execute it with the new host name in `VKV_HOSTNAME` and the appropriate email in `VKV_EMAIL` to request and use a new certificate instead.