Skip to content

Commit 52d4fdf

Browse files
committed
feat(readme): add instructions for setting up Cloudflare Tunnel and WARP
1 parent eb7732c commit 52d4fdf

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,30 @@ _This [Ansible](https://ansible.com) configuration automates the setup of a Home
9090

9191
## 🛠️ Configuration
9292

93-
This project uses Ansible's best practices for variable management, separating public configuration from private secrets.
93+
### Cloudflare One
9494

95-
### 1. Public Configuration (`group_vars/all/main.yml`)
95+
#### Cloudflare Tunnel - access your services publicly
96+
97+
Follow the guide [1. Connect the server to Cloudflare](https://developers.cloudflare.com/cloudflare-one/networks/connectors/cloudflare-tunnel/private-net/cloudflared/connect-cidr/#1-connect-the-server-to-cloudflare) to create a [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/networks/connectors/cloudflare-tunnel). This is a required step for accessing the services remotely.
98+
99+
> [!IMPORTANT]
100+
> If you reach the **Install and run connectors** step, please just select installation with **Docker** and just copy the token and paste it into the Ansible vault (`cloudflared_token`). Please run the `cloudflare_tunnel` task with to connect to the tunnel:
101+
>
102+
> ```sh
103+
> ansible-playbook deploy.yml --tags cloudflare_tunnel
104+
> ```
105+
106+
#### Cloudflare WARP - connect to your home network remotely and securely
107+
108+
Follow the guide [Gateaway with WARP (default)](https://developers.cloudflare.com/cloudflare-one/team-and-resources/devices/warp/set-up-warp/#gateway-with-warp-default) to successfully set up **Cloudflare WARP** to remotely connect to your home network securely. You can skip step **4. Install the Cloudflare root certificate on your devices.**.
109+
110+
### Ansible Variables
111+
112+
#### 1. Public Configuration (`group_vars/all/main.yml`)
96113

97114
This file contains all non-sensitive configuration for your server, such as domain names, ports, and feature flags. Open `group_vars/all/main.yml` and customize the settings to match your environment.
98115

99-
### 2. Secret Management (`group_vars/all/vault.yml`)
116+
#### 2. Secret Management (`group_vars/all/vault.yml`)
100117

101118
All sensitive data (API keys, passwords, secrets) is stored in an encrypted Ansible Vault file. For convenience, we will store the vault password in a local, git-ignored file.
102119

0 commit comments

Comments
 (0)