Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added clarifier about CF token and re-synced README #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

added clarifier about CF token and re-synced README #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ $ pip install fastcaddy

## Installing Caddy

``` python
from fastcore.utils import *
```

This project is to help you use the caddy API, rather than a Caddyfile,
to use caddy. To use the API, you need to install a plugin for your
domain management service. We use Cloudflare, so we’ll document that
here. For other domain services, see the Caddy docs for other plugins.

### Cloudflare setup

``` python
from fastcore.utils import *
```

You’ll need a token from Cloudflare with access to modify the necessary
settings. Here’s the steps to create a token with the minimal
privileges. You’ll need to install the cloudflare pip package, then
Expand All @@ -38,6 +38,11 @@ from cloudflare import Cloudflare
Then you’ll need create a Cloudflare API token for your user, which
we’ll then use to create the less privileged token.

To create your user API token in Cloudflair, go to My Profile \> API
Tokens. Create the token using the template “Create Additional Tokens.”
This will pre-select the “User.API Tokens” Edit permission for you. Add
the “Zone.Zone” Read permission, as well.

``` python
cf_token = os.environ['CLOUDFLARE_API_TOKEN']
```
Expand Down Expand Up @@ -194,7 +199,7 @@ If all went well, you should see output like this:

We will now show how to set up caddy as a reverse proxy for hosts added
dynamically. We’ll grab our token from the previous step (assuming here
that it’s stored in an env var:
that it’s stored in an env var):

``` python
cf_token = os.environ.get('CADDY_CF_TOKEN', 'XXX')
Expand Down
10 changes: 6 additions & 4 deletions nbs/index.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Then you'll need create a Cloudflare API token for your user, which we'll then use to create the less privileged token."
"Then you'll need create a Cloudflare API token for your user, which we'll then use to create the less privileged token.\n",
"\n",
"To create your user API token in Cloudflair, go to My Profile > API Tokens. Create the token using the template \"Create Additional Tokens.\" This will pre-select the \"User.API Tokens\" Edit permission for you. Add the \"Zone.Zone\" Read permission, as well."
]
},
{
Expand Down Expand Up @@ -377,7 +379,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"To view the configuration created, use `gcfg`:"
"To view the configuration created, use [`gcfg`](https://AnswerDotAI.github.io/fastcaddy/core.html#gcfg):"
]
},
{
Expand Down Expand Up @@ -445,7 +447,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"To add a reverse proxy, use `add_reverse_proxy`:"
"To add a reverse proxy, use [`add_reverse_proxy`](https://AnswerDotAI.github.io/fastcaddy/core.html#add_reverse_proxy):"
]
},
{
Expand All @@ -462,7 +464,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"This is automatically added with an id matching the host, which you can view with `gid`:"
"This is automatically added with an id matching the host, which you can view with [`gid`](https://AnswerDotAI.github.io/fastcaddy/core.html#gid):"
]
},
{
Expand Down