Skip to content

Fix run commands on the Contextual Access examples page #1085

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

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

Fix run commands on the Contextual Access examples page #1085

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
14 changes: 7 additions & 7 deletions app/en/guides/contextual-access/examples/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Running a Server"
description: "Run open-source example webhook servers to get started with Contextual Access"
---

# Running an Server
# Running a Server

The fastest way to get started with Contextual Access is to run one of the open-source example servers. These are example Go implementations you can use as-is or as a starting point for your own server.

Expand Down Expand Up @@ -43,7 +43,7 @@ cd logic-extensions-examples/
**Advanced server (with web dashboard):**

```bash
go run ./examples/contextual_access/advanced_server -config ./examples/advanced_server/example-config.yaml
go run ./examples/contextual_access/advanced_server -config ./examples/contextual_access/advanced_server/example-config.yaml
```

**Focused examples:**
Expand All @@ -56,24 +56,24 @@ go run ./examples/contextual_access/pii_redactor -types "email,ssn,credit_card"
go run ./examples/contextual_access/user_blocking -block "user1,user2"

# Content filter (access, pre, post)
go run ./examples/contextual_access/content_filter -config ./examples/content_filter/example-config.yaml
go run ./examples/contextual_access/content_filter -config ./examples/contextual_access/content_filter/example-config.yaml

# A/B testing (pre-hook)
go run ./examples/contextual_access/ab_testing -config ./examples/ab_testing/example-config.yaml
go run ./examples/contextual_access/ab_testing -config ./examples/contextual_access/ab_testing/example-config.yaml

# Basic rules (all hooks, configurable via YAML)
go run ./examples/contextual_access/basic_rules -config ./examples/basic_rules/example-config.yaml
go run ./examples/contextual_access/basic_rules -config ./examples/contextual_access/basic_rules/example-config.yaml
```

Each server exposes `GET /health`, `POST /access`, `POST /pre`, and `POST /post` (or a subset, depending on which hook points it implements).

## Connect to the Arcade
## Connect to Arcade

Once your server is running:

1. Open the **Arcade Dashboard** and navigate to **Contextual Access**
2. Click **Create Extension** and enter your server's base URL and endpoint paths
4. Create **hook configurations** to attach the extension to the hook points you want
3. Create **hook configurations** to attach the extension to the hook points you want

See [How Hooks Work](/guides/contextual-access/how-hooks-work) for details on configuring extensions and hook points.

Expand Down
Loading