Documentation
Getting Started

Installation

Fork the repo

  1. Fork the repository, you just need the main branch
  2. Push the forked public repository or create a new private repository on GitHub:
    1. git init
    2. git add .
    3. git commit -m “first commit”
    4. git branch -M main
    5. git remote add origin …
    6. git push -u origin main

On Cloudflare

  1. Create a project underneath Cloudflare Workers & Pages
    • Connect the repository
    • Configure your deployment and build setup:
      • Framework preset: (leave empty)
      • Build command: cat static.lnk dynamic.lnk > build/_redirects
      • Build output directory: /build
    • The build will fail as you still need to generate static.lnk, dynamic.lnk, and build/_headers later in the process
  2. Setup a custom domain for your page project

Local config

  1. Define your configuration in the vanityURLs.conf with your preferred text editor or via make config if vi is your cup of tea
    • SCRIPT_DIR: the path to your local scripts folder included in your path
    • REPO_DIR: the path to your local copy of vanityURLs
    • MY_DOMAIN: your tiny internet domain served by Cloudflare
    • MY_PAGE: your Cloudflare’s specific page URL
  2. Build your initial setup with make setup
  3. Update the static and dynamic redirection lists with your preferred text editor and the lnk bash script
  4. Update the main branch of your local git repository and push to GitHub
  5. Cloudflare will detect the change and initiate a deployment, please give ~15 seconds for your links to become valid
  6. Open the defined fully qualified domain name for your tiny internet domain name in your web browser, and you should be redirected to https://BHDicaire.com based on the initial configuration
  7. Fine tune the static and dynamic redirection lists with your preferred text editor and the lnk bash script
  8. Add and commit the change to the github repository
DocumentationGuide