Skip to content

Latest commit

 

History

History
61 lines (34 loc) · 4.52 KB

getting-started.md

File metadata and controls

61 lines (34 loc) · 4.52 KB
Raw

Index ┊ Back ┊ Access policy

Getting started

Before we start you need to take note of your Zone and Account IDs. To find them, login into your account and select the zone (domain) where you plan to use Wildebeest. Then, on the Overview page you will see something like this:

zone and account IDs

Take note, you need this information later. Let's start the installation process.

Wildebeest uses Deploy to Workers to automate the installation process.

Click here to start the installation.

Please pay attention to all the steps involved in the installation process.

  • Authorize Workers to use your GitHub account.
  • Enter your Account ID (from the previous section)
  • Press the Create token button first, to create it, it will redirect you to a token template with all the required permissions pre-configured. Then enter the API token in the form.
  • Enter the Zone ID, Domain, Title, Admin Email and Description for your instance.
  • Fork the repository into your personal GitHub account.
  • Enable GitHub Actions.
  • Deploy.

Here is each step again, with screenshots:

Authorizations and API Token

The first steps are authorizing Workers to use your GitHub account and entering your Account ID, pressing the Create token button and pasting the token in the API Token field.

deploy to workers

Instance configuration

Here we configure the instance/project with the Zone ID, Domain (the full FQDN domain of your zone, where you want to deploy your Wildebeest server), Title, Admin Email and Description.

configure instance

Now click Fork the repository.

Then enable GitHub Actions and confirm by clicking Workflows enabled.

And finally click Deploy.

deploy

The installation script will now build and deploy your project to Cloudflare Pages and will run a Terraform script to configure D1, Workers, DNS, Images and Access settings automatically for you.

Make sure the deploy was successful by looking at the GitHub Actions logs. If it wasn't, take a look at errors, we did our best trying to make then clear.

Finish installation

If you followed all the steps, you should see a successful GitHub Actions build.

github actions secrets

You can also confirm in the Cloudflare dashboard that the Pages project, DNS entry, KV namespace, D1 database and Access rule were all created and configured.

Index ┊ Back ┊ Access policy