bnkops/Changemaker
bnkops/Changemaker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme updates

Browse Source
This commit is contained in:
admin 2025-05-15 12:50:12 -06:00
parent 3017f14de4
commit 03b38dbd6f
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -75,11 +75,11 @@ git clone https://gitea.bnkhome.org/bnkops/Changemaker.git
cd changemaker
```
For local development, cloudflare credentials can be ignored.
See [Setting Up Cloudflare Credentials](#setting-up-cloudflare-credentials) for how to get cloudflare credentials for config.sh.
```bash
# Use default configuration for local development.
# To configure for remote deployment with Cloudflare, first make the script executable:
chmod +x config.sh
# Then run the configuration script. You will need your Cloudflare details.
@ -224,33 +224,30 @@ All services can now be accessed through on local machine. If deploying to publi
For secure remote access to your services, you can set up a Cloudflare Tunnel.
### Install Cloudflared on Ubuntu 24.04
[Cloudflared Installation Guide](https://gitea.bnkhome.org/bnkops/scripts/src/branch/main/build.homelab.md#cloudflaredhttpsdeveloperscloudflarecomcloudflare-oneconnectionsconnect-networks)
### [Install Cloudflared on Ubuntu 24.04](https://gitea.bnkhome.org/bnkops/scripts/src/branch/main/build.homelab.md#cloudflaredhttpsdeveloperscloudflarecomcloudflare-oneconnectionsconnect-networks)
### Configure Your Cloudflare Tunnel
You can use our [Cloudflare Configuration Guide](https://gitea.bnkhome.org/bnkops/scripts/src/branch/main/config.cloudflare.homelab.md) however remember to copy the values of the [example config](/example.cloudflare.config.yml) for this deployment.
### Create a Cloudflare System Service
[Cloudflare Service Setup Guide](https://gitea.bnkhome.org/bnkops/scripts/src/branch/main/service.cloudflared.md)
### [Create a Cloudflare System Service](https://gitea.bnkhome.org/bnkops/scripts/src/branch/main/service.cloudflared.md)
### Add CNAME Records
After setting up your Cloudflare Tunnel, you need to add CNAME records for your services. You can do this manually in the Cloudflare DNS panel or with using the following script: `add-cname-records.sh`
```bash
# Make the script executable
chmod +x add-cname-records.sh
> [!warning] Deleting DNS Records
Running this script will delete all DNS records that are connected to this Cloudflare account.
```bash
# Run the script to add CNAME records
./add-cname-records.sh
```
This script will add CNAME records for all Changemaker services to your Cloudflare DNS.
It will also set up a Cloudflare Access Application for all services execpt for your website and gitea. This is a extra layer of security that we do recommend for your deployment. It will automatically allow any emails with from the root domain that you set in the `config.sh` process. For example, if you set your root domain to `example.com` your access rule will allow emails ending with @example.com thorugh. You can update your access settings in the Cloudflare Zero Trust dashboard.
It will also set up a Cloudflare Access Application for all applications without access control. This is a extra layer of security that we do recommend for your deployment. It will automatically allow any emails with from the root domain that you set in the `config.sh` process. For example, if you set your root domain to `example.com` your access rule will allow emails ending with @example.com thorugh. It will also allow your set `admin email` access to these applications. You can update your access settings in the [Cloudflare Zero Trust](https://developers.cloudflare.com/cloudflare-one/) dashboard.
> [!warning] ⚠️ Cloudflare Zero Trust ⚠️