Readme and install instructions

README.md

@@ -1 +1,50 @@
+
 # wireguard_webadmin
+
+wireguard_webadmin is a full-featured yet easy-to-configure web interface for managing WireGuard VPN instances. Designed to simplify the administration of WireGuard networks, it provides a user-friendly interface that supports multiple users with varying access levels, multiple WireGuard instances with individual peer management, and support for crypto key routing for site-to-site interconnections.
+
+## Features
+
+- **Multi-User Support**: Manage access with different permission levels for each user.
+- **Multiple WireGuard Instances**: Enables separate management for peers across multiple instances.
+- **Crypto Key Routing**: Simplifies the configuration for site-to-site interconnections.
+
+This project aims to offer an intuitive and user-friendly solution for WireGuard VPN management without compromising the power and flexibility WireGuard provides.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Deployment
+
+Follow these steps to deploy wireguard_webadmin:
+
+1. Clone the repository:
+   ```
+   git clone https://github.com/eduardogsilva/wireguard_webadmin
+   ```
+
+2. Create the `wireguard_webadmin/production_settings.py` file and configure the minimum required variables:
+   ```python
+   DEBUG = False
+   ALLOWED_HOSTS = ['your_domain']
+   CSRF_TRUSTED_ORIGINS = ['https://your_domain']
+   SECRET_KEY = 'your_secret_key'
+   ```
+
+3. Place your SSL certificates for nginx in the `certificates` volume.
+
+4. Run Docker Compose:
+   ```
+   docker-compose up
+   ```
+
+After completing these steps, your wireguard_webadmin should be up and running. Access your server using `http://your_domain` and start configuring it.
+
+## Contributing
+
+Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+## Support
+
+If you encounter any issues or require assistance, please open an issue on the project's GitHub page.

templates/base.html

@@ -179,7 +179,7 @@
   <footer class="main-footer">
     wireguard-webadmin 
     <div class="float-right d-none d-sm-inline-block">
-      <b>Version</b> 0.0001
+      <b>Version</b> 0.8 beta
     </div>
   </footer>
 

templates/wireguard/welcome.html

@@ -1,5 +1,21 @@
 {% extends "base.html" %}
 
 {% block content %}
-this page is just a placeholder for the moment
+<h1>Welcome to wireguard_webadmin</h1>
+    <p>I've been working hard on it over the past week and plan to continue making corrections and finishing it in the coming days.</p>
+    <p>Currently, it's quite functional, but there's still a need to polish various aspects of the interface to enhance usability.</p>
+    <p>If you encounter any issues or have suggestions, please open an issue on GitHub so I can review it.</p>
+    <h2>Important Points to Note:</h2>
+    <ul>
+        <li>The peers page does not yet display data from WireGuard such as the last handshake and data transfer.</li>
+        <li>The verification of allowed IPs against the output of wg show has not yet been implemented. This will help detect configuration errors for crypto routing.</li>
+        <li>After editing a peer or server settings, go to the status page and click to update the WireGuard configurations, then restart the service. I still need to make this process more intuitive.</li>
+        <li>The DNS server provided to the peer is still hardcoded.</li>
+    </ul>
+    <p>Your involvement and feedback are crucial to the development of wireguard_webadmin. Together, we can refine and enhance its functionality. Thank you for being part of this journey!</p>
+
+    <h2>Don't Forget</h2>
+    <p>Remember to save your configuration changes and restart the service for them to take effect.</p>
+    <p>Keep checking the GitHub page, I will be updating this project very soon.</p>
+
 {% endblock %}