diff options
author | Egor Tensin <Egor.Tensin@gmail.com> | 2021-10-03 12:34:45 +0300 |
---|---|---|
committer | Egor Tensin <Egor.Tensin@gmail.com> | 2021-10-03 12:34:45 +0300 |
commit | 2b2c5ab94dd5365e727dab154b2efa5bdbc86165 (patch) | |
tree | 27e5f44784090ab37a00f1b478b49aad8a5f6785 | |
parent | tweak systemd output a bit (diff) | |
download | wireguard-config-2b2c5ab94dd5365e727dab154b2efa5bdbc86165.tar.gz wireguard-config-2b2c5ab94dd5365e727dab154b2efa5bdbc86165.zip |
add README.md
-rw-r--r-- | README.md | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0f3051b --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +WireGuard configuration +======================= + +Generate WireGuard configuration files. +Hosted on [GitHub Pages] at https://egor-tensin.github.io/wireguard-config/. + +[GitHub Pages]: https://pages.github.com + +Development +----------- + +[Jekyll] is used to build a set of static HTML pages from a collection of +templates and resources. +[Bundler] is used to manage project's dependencies. +Make sure you have the `bundler` gem installed; project dependencies can then +be installed by executing + + bundle install + +in the project's root directory. + +To run a local web server, run + + bundle exec jekyll serve --drafts + +You can then review your changes at http://localhost:4000/wireguard-config/. + +Or you can use [jekyll-docker] to set up a development environment in Docker +and not bother with installing everything locally. + +[jekyll-theme] is used as a remote Jekyll theme. + +[Jekyll]: https://jekyllrb.com/ +[Bundler]: http://bundler.io/ +[jekyll-docker]: https://github.com/egor-tensin/jekyll-docker +[jekyll-theme]: https://github.com/egor-tensin/jekyll-theme + +### Access via file:// + +Jekyll doesn't provide native support for generating a static website which can +be browsed without running an instance of Jekyll's web server. +One easy workaround is to `wget` the website and convert the links: + + wget --no-verbose --recursive --convert-links --adjust-extension -- http://localhost:4000/blog/ + +Security +-------- + +This page only works on the client side - GitHub Pages doesn't allow +server-side processing. +Nothing really prevents me from sending your keys to an external server using +JavaScript, but you can easily verify that it doesn't happen using your +browser's debugging tools. + +License +------- + +Distributed under the MIT License. +See [LICENSE.txt] for details. + +[LICENSE.txt]: LICENSE.txt |