Skip to content

Commit 8bf34f3

Browse files
evantahlernbarbettini
evantahler
and
nbarbettini
authored
Cleanup Hosting options for an MCP world (#471)
* Cleanup Hosting options for an MCP world * Update app/en/home/deployment/_meta.tsx Co-authored-by: Nate Barbettini <[email protected]> * plural * simplify auth providers by removing links to self hosting (except for custom oauth) * fix links * remove 'worker running' * re-apply nate's fixes * bump on-prem deps * Less 'worker' * engine link removal from auth providers * Update app/en/home/deployment/engine-configuration/page.mdx Co-authored-by: Nate Barbettini <[email protected]> * remove more cruft * remove tabs * more cleanup * even more engine removals --------- Co-authored-by: Nate Barbettini <[email protected]>
1 parent 97777be commit 8bf34f3

File tree

59 files changed

+1006
-2829
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+1006
-2829
lines changed

‎app/en/home/_meta.tsx‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,8 @@ export const meta: MetaRecord = {
106106
"hosting-overview": {
107107
title: "Overview",
108108
},
109-
"hybrid-deployment": {
110-
title: "Hybrid Deployment",
111-
},
112-
"local-deployment": {
113-
title: "Local Deployment",
109+
deployment: {
110+
title: "Deployment",
114111
},
115112
"auth-providers": {
116113
title: "Customizing Auth",

‎app/en/home/auth-providers/asana/page.mdx‎

Lines changed: 6 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { Tabs, Callout, Steps } from "nextra/components";
22

33
# Asana
44

5-
The Asana auth provider enables tools and agents to call Asana APIs on behalf of a user. Behind the scenes, the Arcade Engine and the Asana auth provider seamlessly manage Asana OAuth 2.0 authorization for your users.
5+
The Asana auth provider enables tools and agents to call Asana APIs on behalf of a user.
66

77
<Callout>
88
Want to quickly get started with Asana services in your agent or AI app? The
@@ -38,7 +38,6 @@ If you choose to use Arcade's Asana auth, you don't need to configure anything.
3838

3939
In a production environment, you will most likely want to use your own Asana app credentials. This way, your users will see your application's name requesting permission.
4040

41-
You can use your own Asana credentials in both the Arcade Cloud Platform or in a [self-hosted Arcade Engine](/home/local-deployment/install/local) instance.
4241

4342
Before showing how to configure your Asana app credentials, let's go through the steps to create an Asana app.
4443

@@ -68,14 +67,8 @@ When creating your app, use the following settings:
6867

6968
## Configuring your own Asana Auth Provider in Arcade
7069

71-
There are two ways to configure your Asana app credentials in Arcade:
7270

73-
1. From the Arcade Dashboard GUI
74-
2. By editing the `engine.yaml` file directly (only possible with a self-hosted Arcade Engine)
75-
76-
We show both options step-by-step below.
77-
78-
<Tabs items={["Dashboard GUI", "Engine Configuration YAML"]}>
71+
<Tabs items={["Dashboard GUI"]}>
7972
<Tabs.Tab>
8073

8174
### Configure Asana Auth Using the Arcade Dashboard GUI
@@ -102,68 +95,11 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
10295

10396
#### Create the provider
10497

105-
Hit the **Create** button and the provider will be ready to be used in the Arcade Engine.
98+
Hit the **Create** button and the provider will be ready to be used.
10699

107100
</Steps>
108101

109-
When you use tools that require Asana auth using your Arcade account credentials, the Arcade Engine will automatically use this Asana OAuth provider. If you have multiple Asana providers, see [using multiple auth providers of the same type](/home/auth-providers#using-multiple-providers-of-the-same-type) for more information.
110-
111-
</Tabs.Tab>
112-
<Tabs.Tab>
113-
114-
### Configure Asana Auth Using the Engine Configuration YAML
115-
116-
<Callout>
117-
Refer to [Engine configuration](/home/local-deployment/configure/engine) for
118-
more information on how to set environment variables and configure the Arcade
119-
Engine.
120-
</Callout>
121-
122-
<Steps>
123-
124-
#### Set environment variables
125-
126-
Set the following environment variables:
127-
128-
```bash
129-
export ASANA_CLIENT_ID="<your client ID>"
130-
export ASANA_CLIENT_SECRET="<your client secret>"
131-
```
132-
133-
Or, you can set these values in a `.env` file:
134-
135-
```bash
136-
ASANA_CLIENT_ID="<your client ID>"
137-
ASANA_CLIENT_SECRET="<your client secret>"
138-
```
139-
140-
#### Edit the Engine configuration
141-
142-
<Callout>
143-
To locate the `engine.yaml` file in your OS after installing the Arcade
144-
Engine, check the [Engine configuration
145-
file](/home/local-deployment/configure/overview#engine-configuration-file)
146-
documentation.
147-
</Callout>
148-
149-
Edit the `engine.yaml` file and add an Asana item to the `auth.providers` section:
150-
151-
```yaml {3-9}
152-
auth:
153-
providers:
154-
- id: asana
155-
description: "Custom Asana provider"
156-
enabled: true
157-
type: oauth2
158-
client_id: ${env:ASANA_CLIENT_ID}
159-
client_secret: ${env:ASANA_CLIENT_SECRET}
160-
```
161-
162-
#### Restart the Arcade Engine
163-
164-
If the Arcade Engine is already running, you will need to restart it for the changes to take effect.
165-
166-
</Steps>
102+
When you use tools that require Asana auth using your Arcade account credentials, Arcade will automatically use this Asana OAuth provider. If you have multiple Asana providers, see [using multiple auth providers of the same type](/home/auth-providers#using-multiple-providers-of-the-same-type) for more information.
167103

168104
</Tabs.Tab>
169105
</Tabs>
@@ -188,9 +124,7 @@ Use `client.auth.start()` to get a user token for the Asana API:
188124

189125
<Tabs items={["Python", "JavaScript"]}>
190126
<Tabs.Tab>
191-
<Callout type="info">
192-
If you are [self-hosting Arcade](/home/local-deployment/install/overview), change the `base_url` parameter in the `Arcade` constructor to match your Arcade Engine URL. By default, the Engine will be available at `http://localhost:9099`.
193-
</Callout>
127+
194128

195129
```python {21-22}
196130
from arcadepy import Arcade
@@ -220,9 +154,7 @@ auth_token = auth_response.context.token
220154
</Tabs.Tab>
221155

222156
<Tabs.Tab>
223-
<Callout type="info">
224-
If you are [self-hosting Arcade](/home/local-deployment/install/overview), change the `baseURL` parameter in the `Arcade` constructor to match your Arcade Engine URL. By default, the Engine will be available at `http://localhost:9099`.
225-
</Callout>
157+
226158

227159
```javascript {20-21}
228160
import { Arcade } from "@arcadeai/arcadejs";
@@ -294,7 +226,6 @@ async def delete_task(
294226
return response.json()
295227
```
296228

297-
If you are [self-hosting Arcade](/home/local-deployment/install/overview), you will need to restart the Arcade Worker and the Engine for the new tool to be available.
298229

299230
Your new tool can be called like demonstrated below:
300231

‎app/en/home/auth-providers/atlassian/page.mdx‎

Lines changed: 4 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Tabs, Callout, Steps } from "nextra/components";
88
OAuth 2.0 credentials as described below.
99
</Callout>
1010

11-
The Atlassian auth provider enables tools and agents to call the Atlassian API on behalf of a user. Behind the scenes, the Arcade Engine and the Atlassian auth provider seamlessly manage Atlassian OAuth 2.0 authorization for your users.
11+
The Atlassian auth provider enables tools and agents to call the Atlassian API on behalf of a user.
1212

1313
### What's documented here
1414

@@ -31,7 +31,6 @@ This auth provider is used by:
3131

3232
In a production environment, you will most likely want to use your own Atlassian app credentials. This way, your users will see your application's name requesting permission.
3333

34-
You can use your own Atlassian credentials in both the Arcade Cloud Platform or in a [self-hosted Arcade Engine](/home/local-deployment/install/local) instance.
3534

3635
Before showing how to configure your Atlassian app credentials, let's go through the steps to create an Atlassian app.
3736

@@ -44,14 +43,8 @@ Before showing how to configure your Atlassian app credentials, let's go through
4443

4544
## Configuring your own Atlassian Auth Provider in Arcade
4645

47-
There are two ways to configure your Atlassian app credentials in Arcade:
4846

49-
1. From the Arcade Dashboard GUI
50-
2. By editing the `engine.yaml` file directly (for a self-hosted Arcade Engine)
51-
52-
We show both options step-by-step below.
53-
54-
<Tabs items={["Dashboard GUI", "Engine Configuration YAML"]}>
47+
<Tabs items={["Dashboard GUI"]}>
5548
<Tabs.Tab>
5649

5750
### Configure Atlassian Auth Using the Arcade Dashboard GUI
@@ -78,56 +71,10 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
7871

7972
#### Create the provider
8073

81-
Hit the **Create** button and the provider will be ready to be used in the Arcade Engine.
82-
83-
</Steps>
84-
When you use tools that require Atlassian auth using your Arcade account credentials, the Arcade Engine will automatically use this Atlassian OAuth provider. If you have multiple Atlassian providers, see [using multiple auth providers of the same type](/home/auth-providers#using-multiple-providers-of-the-same-type) for more information.
85-
86-
</Tabs.Tab>
87-
<Tabs.Tab>
88-
### Configuring Atlassian auth in self-hosted Arcade Engine configuration
89-
90-
<Steps>
91-
92-
### Set environment variables
93-
94-
Set the following environment variables:
95-
96-
```bash
97-
export ATLASSIAN_CLIENT_ID="<your client ID>"
98-
export ATLASSIAN_CLIENT_SECRET="<your client secret>"
99-
```
100-
101-
Or, you can set these values in a `.env` file:
102-
103-
```bash
104-
ATLASSIAN_CLIENT_SECRET="<your client secret>"
105-
ATLASSIAN_CLIENT_ID="<your client ID>"
106-
```
107-
108-
<Callout>
109-
See [Engine configuration](/home/local-deployment/configure/engine) for more
110-
information on how to set environment variables and configure the Arcade
111-
Engine.
112-
</Callout>
113-
114-
### Edit the Engine configuration
115-
116-
Edit the `engine.yaml` file and add a `atlassian` item to the `auth.providers` section:
117-
118-
```yaml {3-9}
119-
auth:
120-
providers:
121-
- id: default-atlassian
122-
description: "The default Atlassian provider"
123-
enabled: true
124-
type: oauth2
125-
provider_id: atlassian
126-
client_id: ${env:ATLASSIAN_CLIENT_ID}
127-
client_secret: ${env:ATLASSIAN_CLIENT_SECRET}
128-
```
74+
Hit the **Create** button and the provider will be ready to be used.
12975

13076
</Steps>
77+
When you use tools that require Atlassian auth using your Arcade account credentials, Arcade will automatically use this Atlassian OAuth provider. If you have multiple Atlassian providers, see [using multiple auth providers of the same type](/home/auth-providers#using-multiple-providers-of-the-same-type) for more information.
13178

13279
</Tabs.Tab>
13380
</Tabs>

‎app/en/home/auth-providers/clickup/page.mdx‎

Lines changed: 4 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { Tabs, Callout, Steps } from "nextra/components";
22

33
# ClickUp
44

5-
The ClickUp auth provider enables tools and agents to call the ClickUp API on behalf of a user. Behind the scenes, the Arcade Engine and the ClickUp auth provider seamlessly manage ClickUp OAuth 2.0 authorization for your users.
5+
The ClickUp auth provider enables tools and agents to call the ClickUp API on behalf of a user.
66

77
### What's documented here
88

@@ -25,7 +25,6 @@ This auth provider is used by:
2525
In a production environment, you will most likely want to use your own ClickUp app
2626
credentials. This way, your users will see your application's name requesting permission.
2727

28-
You can use your own ClickUp credentials in both the Arcade Cloud Platform or in a [self-hosted Arcade Engine](/home/local-deployment/install/local) instance.
2928

3029
Before showing how to configure your ClickUp app credentials, let's go through the steps to create a ClickUp app.
3130

@@ -37,18 +36,9 @@ Before showing how to configure your ClickUp app credentials, let's go through t
3736
- Set the OAuth Redirect URL to: `https://cloud.arcade.dev/api/v1/oauth/callback`
3837
- Copy the Client ID and Client Secret, which you'll need below
3938

40-
Next, add the ClickUp app to your Arcade Engine configuration. You can do this in the Arcade Dashboard, or by editing the `engine.yaml` file directly (for a self-hosted instance).
41-
4239
## Configuring your own ClickUp Auth Provider in Arcade
4340

44-
There are two ways to configure your ClickUp app credentials in Arcade:
45-
46-
1. From the Arcade Dashboard GUI
47-
2. By editing the `engine.yaml` file directly (for a self-hosted Arcade Engine)
48-
49-
We show both options step-by-step below.
50-
51-
<Tabs items={["Dashboard GUI", "Engine Configuration YAML"]}>
41+
<Tabs items={["Dashboard GUI"]}>
5242
<Tabs.Tab>
5343

5444
### Configure ClickUp Auth Using the Arcade Dashboard GUI
@@ -74,58 +64,11 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
7464

7565
#### Create the provider
7666

77-
Hit the **Create** button and the provider will be ready to be used in the Arcade Engine.
67+
Hit the **Create** button and the provider will be ready to be used.
7868

7969
</Steps>
8070

81-
When you use tools that require ClickUp auth using your Arcade account credentials, the Arcade Engine will automatically use this ClickUp OAuth provider. If you have multiple ClickUp providers, see [using multiple auth providers of the same type](/home/auth-providers#using-multiple-providers-of-the-same-type) for more information.
82-
83-
</Tabs.Tab>
84-
<Tabs.Tab>
85-
86-
### Configuring ClickUp auth in self-hosted Arcade Engine configuration
87-
88-
<Steps>
89-
90-
### Set environment variables
91-
92-
Set the following environment variables:
93-
94-
```bash
95-
export CLICKUP_CLIENT_ID="<your client ID>"
96-
export CLICKUP_CLIENT_SECRET="<your client secret>"
97-
```
98-
99-
Or, you can set these values in a `.env` file:
100-
101-
```bash
102-
CLICKUP_CLIENT_ID="<your client ID>"
103-
CLICKUP_CLIENT_SECRET="<your client secret>"
104-
```
105-
106-
<Callout>
107-
See [Engine configuration](/home/local-deployment/configure/engine) for more
108-
information on how to set environment variables and configure the Arcade
109-
Engine.
110-
</Callout>
111-
112-
### Edit the Engine configuration
113-
114-
Edit the `engine.yaml` file and add a `clickup` item to the `auth.providers` section:
115-
116-
```yaml {3-9}
117-
auth:
118-
providers:
119-
- id: default-clickup
120-
description: "The default ClickUp provider"
121-
enabled: true
122-
type: oauth2
123-
provider_id: clickup
124-
client_id: ${env:CLICKUP_CLIENT_ID}
125-
client_secret: ${env:CLICKUP_CLIENT_SECRET}
126-
```
127-
128-
</Steps>
71+
When you use tools that require ClickUp auth using your Arcade account credentials, Arcade will automatically use this ClickUp OAuth provider. If you have multiple ClickUp providers, see [using multiple auth providers of the same type](/home/auth-providers#using-multiple-providers-of-the-same-type) for more information.
12972

13073
</Tabs.Tab>
13174
</Tabs>

0 commit comments

Comments
 (0)