diff --git a/README.md b/README.md index 31523c3..4aced08 100644 --- a/README.md +++ b/README.md @@ -41,12 +41,45 @@ Overall, this Raspberry Pi Home Internet Gateway provides a comprehensive soluti ansible-galaxy collection install -r requirements.yml ``` > **Note**: If you see `ansible-galaxy: command not found`, you have to relogin (or reboot your Pi) and then try again. +
+ Continue Installation with WebUI + + **This is still under testing!** If you afraid of it - just skip to CLI installation. + + 5. Run [Webinstall](https://github.com/d3vilh/raspberry-gtw-webconfig) binary: + ```shell + secret@rpgw:~/raspberry-gateway $ ./webinstall + 2023/07/07 18:01:03 Welcome! The web interface will guide you on installation process. + Installation logs: webinstall.log + 2023/07/07 18:01:03 Starting web server on http://10.10.10.18:8088 + ``` + 6. Copy server address (`http://10.10.10.18:8088` as above example) from the console and paste into your browser, then press Enter. Raspberry-Gateway webinstall window will appear: + ![Raspberry Monitoring Dashboard in Grafana picture 1](/images/Webinstall-01.png) + 7. Choose all the components you would like to install and change all the passwords (keep them in mind). + > **Note**: You can leave all the passwords as default, but it's not recommended. + 8. Press "Save" button. When your configuration is ready: + ![Raspberry Monitoring Dashboard in Grafana picture 1](/images/Webinstall-02.png) + 9. Then press "Install" button. It will initiate installation in background: + ![Raspberry Monitoring Dashboard in Grafana picture 1](/images/Webinstall-03.png) + 10. The installation process will take some time. + Once that's done, it'll be like you have a new **Raspberry Gateway** up and running. + + You can scroll down for `Quick Links` or close browser window and anjoy your new Raspberry Gateway. +
+ + Afraid of GUI? Need more control? + +
+ Install everything with CLI + + **Safiest option**. Tested may times and works like a charm. + 5. Make copies of the configuration files and modify them for your enviroment: ```shell - yes | cp -p example.inventory.ini inventory.ini + yes | cp -p example.inventory.yml inventory.yml yes | cp -p example.config.yml config.yml ``` - 6. Modify `inventory.ini` by replace of IP address with your Pi's IP, or comment that line and uncomment the `connection=local` line if you're running it on the Pi you're setting up. **Double check** that the `ansible_user` is correct for your setup. + 6. Modify `inventory.yml` by replace of IP address with your Pi's IP, or comment that line and uncomment the `connection=local` line if you're running it on the Pi you're setting up. **Double check** that the `ansible_user` is correct for your setup. 7. Modify `config.yml` to **enabe or disable desired containers** to be installed on your Pi: **To enable** Prtainer - change `enable_portainer: false` option to `enable_portainer: true` and vs to disable. > **Note**: To make all necesary changes: `nano config.yml`, save the file - `Ctrl+O` and `Ctrl+X` to exit. @@ -97,7 +130,8 @@ Overall, this Raspberry Pi Home Internet Gateway provides a comprehensive soluti ansible-playbook main.yml ``` > **Note**: **If running locally on the Pi**: You may have error like `Error while fetching server API version`. You have to relogin (or reboot your Pi) and then run the playbook again. - +
+ # Features [**Pi-hole**](https://pi-hole.net) or [**Technitium-dns**](https://technitium.com/dns/) as the network-wide ad-blocking solution integrated with own local DNS and DHCP servers: @@ -292,4 +326,4 @@ Overall, this Raspberry Pi Home Internet Gateway provides a comprehensive soluti * [**cAdviser**](https://github.com/d3vilh/cadvisor) and * other pieces of software used in this project. -May 2021, [**d3vilh**](https://github.com/d3vilh) \ No newline at end of file +May 2021, [**d3vilh**](https://github.com/d3vilh) diff --git a/example.inventory.ini b/example.inventory.ini index 4721373..f671965 100644 --- a/example.inventory.ini +++ b/example.inventory.ini @@ -1,5 +1,12 @@ +# Ansible inventory in INI format is +# Depricated option for manual installation!!! + [raspberry_gateway] -#10.0.60.1 ansible_user=pi +#10.0.60.1 ansible_user=pi # depricated # Comment out the previous line and uncomment this to run inside Rasberry Pi. -127.0.0.1 ansible_connection=local ansible_user=pi +127.0.0.1 ansible_connection=local ansible_user=pi #depricated + +# depricated +# everything is depricated :) +# Please stick to YAML format for inventory instead of INI \ No newline at end of file diff --git a/example.inventory.yml b/example.inventory.yml new file mode 100644 index 0000000..b454b42 --- /dev/null +++ b/example.inventory.yml @@ -0,0 +1,14 @@ +all: + hosts: + raspberry_gateway: + ansible_host: 192.168.1.1 + ansible_user: pi + ansible_connection: local + ansible_use: "yes" +# Comment out the previous 4 lines and uncomment 4 lines below to run on remote Raspberry-Gateway enviroment. +# Double check the user name and IP address. +# ansible_host: 192.168.1.1 +# ansible_user: pi +# ansible_connection: ssh +# ansible_use: "yes" +