Skip to content

Commit

Permalink
Merge pull request #13 from d3vilh/dev
Browse files Browse the repository at this point in the history
Merging with DEV
  • Loading branch information
d3vilh authored Jul 10, 2023
2 parents b625a85 + 8f8a77c commit 1680b86
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 6 deletions.
42 changes: 38 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<details>
<summary>Continue Installation with WebUI</summary>

**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.
</details>
Afraid of GUI? Need more control?
<details>
<summary>Install everything with CLI</summary>
**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.
Expand Down Expand Up @@ -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.
</details>
# 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:
Expand Down Expand Up @@ -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)
May 2021, [**d3vilh**](https://github.com/d3vilh)
11 changes: 9 additions & 2 deletions example.inventory.ini
Original file line number Diff line number Diff line change
@@ -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
14 changes: 14 additions & 0 deletions example.inventory.yml
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit 1680b86

Please sign in to comment.