coolfool/flareup repository overview

⁠Self-hosted and Easy-to-deploy Cloudflare based Dynamic DNS service for router

⁠Features

• Support for multiple domains
• Flexible in terms deploying and installing options
• Single multi-arch docker image
• Multi platform binaries

⁠Environment Variables

To run this project, you will need to add the following environment variables to your .env file (or) set them accordingly for use with docker or with your os

USERNAME - Username for flareup service

PASSWORD - Password for flareup service

CF_API_TOKEN - Cloudflare api token with edit permission for required zones i.e domains

PORT (Optional) - By default flareup listen's on port 5335

DOMAINS - Comma(,) seperated domains e.g

example1.domain.tld , example2.domain.tld

PROXIED (Optional, Default:false) - Proxy dns service through cloudflare service

(back to top⁠)

⁠Installation

• FlareUp can be installed and used in the following ways

⁠Docker Run

    docker run -d \
    --name=flareup \
    -e USERNAME=<username> \
    -e PASSWORD=<password> \
    -e CF_API_TOKEN=<cloudflare api token> \
    -e DOMAINS=<comma(,) seperated domain> \
    -e PROXIED=false \
    -p 5335:5335 \
    --restart unless-stopped \
    coolfool/flareup
    

⁠Docker Compose

1) Download [docker-compose.yml]()
2) Open the file in a text editor and fill the environment variables
3) Execute the following command in the same directory
    ```
    docker-compose up -d
    ```
4) FlareUp should start listening on `5335` or the port specified in env vars.

(back to top⁠)

⁠Router Setup

• Important Notes before setup:
  
  1. The flareup update url is https://example.com/update
     
  2. If the router insists on having a hostname for update you can use https://example.com/update?hostname= as url and all.flareup as hostname
     
     

1. The DynamicDNS server will be the hostname where the service is hosted eg. example.com
   

2. Fill the username and password as you entered in environment variable
   

3. Enter the hostname as all.flareup if required
   

4. The update urls are as follows:
   i) https://example.com/update without hostname
   ii) https://example.com/update?hostname= with hostname
   

5. Save settings and the service should start updating cloudflare dns
   

(back to top⁠)

⁠Authors

• @coolfool⁠

(back to top⁠)

⁠License

MIT⁠

(back to top⁠)