This repository contains documentation and scripts for installing and configuring Wireguard VPN.
Wireguard is a modern VPN protocol that is easy to configure and offers high performance and security. This documentation provides step-by-step instructions for installing and setting up Wireguard on various platforms.
//TODO: The documentation is hosted using Hugo, a fast and flexible static site generator. The Hugo documentation website is located in the "/docs" folder of this repository.
To run the Hugo documentation website locally or build the website, you need to install Hugo. Follow these steps to install Hugo:
-
Download Hugo:
- Visit the Hugo Releases page.
- Download the appropriate version of Hugo for your operating system.
- Extract the downloaded file to a location on your system.
-
Add Hugo to PATH (optional):
- If you want to use Hugo globally from the command line, add the directory containing the Hugo executable to your system's PATH.
After installing Hugo, you can run the Hugo documentation website locally to preview changes or test new content. Follow these steps:
- Navigate to the "/docs" folder:
cd ./docs- Run Hugo server:
hugo server- View the website:
Open your web browser and navigate to
http://localhost:1313to view the Hugo documentation website.
To build the static files for the Hugo documentation website, follow these steps:
- Navigate to the "/docs" folder:
cd ./docs- Build the website:
hugo ./- Static files:
After running the
hugocommand, the static files for the documentation website will be generated in the "/docs/public" folder.
If you would like to contribute to the documentation or report an issue, please see the Contributing Guidelines.
This project is licensed under the MIT License.