Skip to content

Commit e017a34

Browse files
authored
[Doc] Mention multiple domain possible ploomber.app & ploomberapp.io (#303)
* [Bug] Remove dead links in the demos * [Doc] `ploomberapp.io` -> `ploomber.app` migration * chore: make ploomber.app the first domain
1 parent e9efb33 commit e017a34

File tree

10 files changed

+40
-36
lines changed

10 files changed

+40
-36
lines changed

doc/apps/dash.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,6 @@ By default applications run with Python 3.11. Refer to this [section](../faq/faq
164164

165165
:::{grid-item-card} Clinical analytics
166166
[![](../../examples/dash/clinical-analytics/screenshot.webp)](https://github.com/ploomber/doc/tree/main/examples/dash/clinical-analytics)
167-
+++
168-
[Live demo](https://delicate-cake-9107.ploomberapp.io)
169167
:::
170168

171169
::::

doc/apps/flask.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,6 @@ A basic Flask app.
133133

134134
:::{grid-item-card} User auth
135135
[![](../../examples/flask/login/screenshot.webp)](https://github.com/ploomber/doc/tree/main/examples/flask/login)
136-
+++
137-
[Live demo](https://empty-haze-3369.ploomberapp.io)
138136
:::
139137

140138
:::{grid-item-card} ML inference

doc/apps/jupyterlab.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ And you're ready to use JupyterLab!
8787

8888
## Real-time collaboration
8989

90-
Collaboration is configured by default! Share your `id.ploomberapp.io` URL with a colleague, the password, and open the same notebook, you'll get Google Doc-like collaboration!
90+
Collaboration is configured by default! Share your URL with a colleague (it'll be using either `id.ploomber.app` or `id.ploomberapp.io`), the password, and open the same notebook, you'll get Google Doc-like collaboration!
9191

9292

9393
![](../static/docker/jupyterlab/jupyter-collab.gif)
@@ -122,7 +122,7 @@ python -c 'import secrets; print(secrets.token_urlsafe())'
122122
Copy the printed value (store it somewhere safe) and save it as a [secret](../user-guide/secrets.md), with
123123
the name `KG_AUTH_TOKEN`, now click on `CREATE`.
124124

125-
Once the application is running, copy the URL (the `someid.ploomberapp.io` URL):
125+
Once the application is running, copy the URL (either `someid.ploomber.app` or `someid.ploomberapp.io`):
126126

127127
![](../static/docker/mlflow/host.png)
128128

@@ -132,10 +132,10 @@ We can connect to the remote kernel. Install JupyterLab locally:
132132
pip install jupyterlab
133133
```
134134

135-
And initialize it with your `someid.ploomberapp.io` URL and the token you set earlier:
135+
And initialize it with your either `someid.ploomber.app` or `someid.ploomberapp.io` URL and the token you set earlier:
136136

137137
```sh
138-
GATEWAY_HOST=someid.ploomberapp.io
138+
GATEWAY_HOST=someid.ploomberapp.io # Should match your app domain (ploomber.app OR ploomberapp.io)
139139
TOKEN=sometoken
140140
jupyter lab --gateway-url=$GATEWAY_HOST --GatewayClient.auth_token=$TOKEN
141141
```

doc/apps/mlflow.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,10 @@ And run the following in a Python session:
9191
import requests
9292
from getpass import getpass
9393

94-
host = input("Enter your {id}.ploomberapp.io URL: ")
94+
# Notes:
95+
# - We're gradually migrating from id.ploomberapp.io to id.ploomber.app
96+
# - Modify this value to match your host
97+
host = input("Enter your {id}.ploomberapp.io URL: ")
9598
password_new = getpass("Enter new password:")
9699

97100
response = requests.patch(
@@ -105,7 +108,7 @@ response.raise_for_status()
105108
print("Your new password is:", password_new)
106109
```
107110

108-
You'll be prompted for your MLflow host (e.g., `something.ploomberapp.io`), you can
111+
You'll be prompted for your MLflow host (e.g., either `id.ploomber.app` or `id.ploomberapp.io`), you can
109112
get this from the Ploomber UI:
110113

111114
![](../static/docker/mlflow/host.png)
@@ -134,6 +137,10 @@ And run the following (replace the `set_tracking_uri` call with your host!):
134137

135138
```python
136139
import mlflow
140+
141+
# Notes:
142+
# - We're gradually migrating from id.ploomberapp.io to id.ploomber.app
143+
# - Modify this value to match your host
137144
mlflow.set_tracking_uri(uri="https://someid.ploomberapp.io")
138145

139146
mlflow.set_experiment("first-experiment")
@@ -149,4 +156,4 @@ If all goes well, you'll see:
149156
2024/03/12 19:44:39 INFO mlflow.tracking.fluent: Experiment with name 'first-experiment' does not exist. Creating a new experiment.
150157
```
151158

152-
And the experiment will be visible from MLflow's dashboard.
159+
And the experiment will be visible from MLflow's dashboard.

doc/apps/panel.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,6 @@ By default applications run with Python 3.11. Refer to this [section](../faq/faq
151151

152152
:::{grid-item-card} Book recommender
153153
[![](../../examples/panel/book-recommender/screenshot.webp)](https://github.com/ploomber/doc/tree/main/examples/panel/book-recommender)
154-
+++
155-
[Live demo](https://gentle-frost-8296.ploomberapp.io)
156154
:::
157155

158156
:::{grid-item-card} Chat with PDF
@@ -167,8 +165,6 @@ By default applications run with Python 3.11. Refer to this [section](../faq/faq
167165

168166
:::{grid-item-card} Customer Chatbot
169167
[![](../../examples/panel/customer-chatbot/screenshot.webp)](https://github.com/ploomber/doc/tree/main/examples/panel/customer-chatbot)
170-
+++
171-
[Live demo](https://black-poetry-5215.ploomberapp.io)
172168
:::
173169

174170
:::{grid-item-card} Multi Page App
@@ -178,8 +174,6 @@ By default applications run with Python 3.11. Refer to this [section](../faq/faq
178174
:::{grid-item-card} Wine Data Postgres App
179175
:link: https://github.com/ploomber/doc/tree/main/examples/panel/app-with-postgres
180176
![](https://github.com/ploomber/doc/raw/main/examples/panel/app-with-postgres/app.png)
181-
+++
182-
[Live demo](https://panel-postgres-demo.ploomberapp.io/app)
183177
:::
184178

185179
::::

doc/apps/vllm.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,9 @@ from openai import OpenAI
143143
# we haven't configured authentication, so we just pass a dummy value
144144
openai_api_key = "PUT_YOUR_API_KEY_HERE"
145145

146-
# modify this value to match your host, remember to add /v1 at the end
146+
# Notes:
147+
# - We're gradually migrating from id.ploomberapp.io to id.ploomber.app
148+
# - Modify this value to match your host, remember to add /v1 at the end
147149
openai_api_base = "https://autumn-snow-1380.ploomberapp.io/v1"
148150

149151
client = OpenAI(

doc/intro.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -115,20 +115,14 @@ Ploomber Cloud allows you to easily deploy apps. **Select a framework** to learn
115115

116116
:::{grid-item-card} Chatbots
117117
[![](../examples/panel/book-recommender/screenshot.webp)](https://github.com/ploomber/doc/tree/main/examples/panel/book-recommender)
118-
+++
119-
[Live demo](https://gentle-frost-8296.ploomberapp.io)
120118
:::
121119

122120
:::{grid-item-card} Analytical dashboards
123121
[![](../examples/dash/clinical-analytics/screenshot.webp)](https://github.com/ploomber/doc/tree/main/examples/dash/clinical-analytics)
124-
+++
125-
[Live demo](https://delicate-cake-9107.ploomberapp.io)
126122
:::
127123

128124
:::{grid-item-card} REST API
129125
[![](../examples/flask/login/screenshot.webp)](https://github.com/ploomber/doc/tree/main/examples/flask/login)
130-
+++
131-
[Live demo](https://empty-haze-3369.ploomberapp.io)
132126
:::
133127

134128
:::{grid-item-card} Machine Learning inference

doc/user-guide/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,6 @@ ploomber-cloud stop --project-id PROJECT_ID
472472
```
473473

474474
Where `PROJECT_ID` is the randomly generated ID. If you did not set a custom name,
475-
the `PROJECT_ID` is the string in the URL (`PROJECT_ID.ploomberapp.io`), if you set
475+
the `PROJECT_ID` is the string in the URL (either `PROJECT_ID.ploomber.app` or `PROJECT_ID.ploomberapp.io`), if you set
476476
a custom name, you can retrieve the `PROJECT_ID` by clicking on the ⚙️ icon next to the
477477
URL in your app detailed view.

doc/user-guide/custom-domains.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,18 @@
44
Custom domains/subdomains are only available to customers in the Pro, Teams and Enterprise plans.
55
```
66

7-
By default, applications are available under `project-id.ploomberapp.io`, where `project-id` is a randomly generated string.
7+
Each application gets a unique URL in the format `project-id.ploomber.app` or `project-id.ploomberapp.io`, where project-id is an automatically generated identifier.
8+
9+
```{important}
10+
We are slowly migrating all new applications to `ploomber.app`, but some existing apps are still on `ploomberapp.io`.
11+
```
812

913
You can customize the [`project-id`](custom-ploomber-subdomain) or bring your [own domain](custom-domain) or [custom subdomain](custom-subdomain).
1014

1115
(custom-ploomber-subdomain)=
12-
## `{custom}.ploomberapp.io`
16+
## `{custom}.ploomber.app` and `{custom}.ploomberapp.io`
1317

14-
If you would like a custom `ploomberapp.io` subdomain, like `my-custom-app.ploomberapp.io`, you can add it during application setup:
18+
If you would like a custom `ploomber.app` or `ploomberapp.io` subdomain, like `my-custom-app.ploomberapp.io`, you can add it during application setup:
1519

1620
![](../static/custom-domains/custom-names.png)
1721

@@ -40,11 +44,14 @@ A new window will display showing the DNS records you need to add ([see the upda
4044

4145
![](../static/custom-domains/pointing-change-dns-records.png)
4246

47+
```{important}
48+
We are slowly migrating all new applications to `ploomber.app`, but some existing apps are still on `ploomberapp.io`. Make sure your DNS records match the domain associated with your application.
49+
```
4350

4451
You must add three DNS records:
4552

46-
1. A `ALIAS` record: `@` as host, and `yourapp.ploomberapp.io` as value (replace `yourapp` with your actual app ID)
47-
2. A `CNAME` record: `www` as host, and `yourapp.ploomberapp.io` as value (replace `yourapp` with your actual app ID)
53+
1. A `ALIAS` record: `@` as host, and `yourapp.ploomberapp.io` (or `yourapp.ploomber.app`) as value (replace `yourapp` with your actual app ID)
54+
2. A `CNAME` record: `www` as host, and `yourapp.ploomberapp.io` (or `yourapp.ploomber.app`) as value (replace `yourapp` with your actual app ID)
4855
3. A `CNAME` record: with the shown **CNAME name** and **CNAME value** (as displayed in the **SSL certification status** section)
4956

5057
```{important}
@@ -103,7 +110,7 @@ A new window will display showing the DNS records you need to add ([see the upda
103110

104111
You must add two records:
105112

106-
1. `CNAME` record: the subdomain you want to add as the host (e.g., if you want to connect `subdomain.yourdomain.com`, then, you must enter `subdomain`) and `yourapp.ploomberapp.io` as value (where `yourapp` is the ID assigned to your application)
113+
1. `CNAME` record: the subdomain you want to add as the host (e.g., if you want to connect `subdomain.yourdomain.com`, then, you must enter `subdomain`) and `yourapp.ploomberapp.io` (or `yourapp.ploomber.app` dependending on your application domain) as value (where `yourapp` is the ID assigned to your application)
107114
2. `CNAME` record: with the shown **CNAME name** and **CNAME value** (as displayed in the **SSL certification status** section)
108115

109116

@@ -143,7 +150,7 @@ if you encounter errors, remove the root domain from the value. (see this
143150

144151

145152
```{important}
146-
DNS record changes might take up to 48 hours to take effect. In the meantime, your application will be accessible from the `ploomberapp.io` URL
153+
DNS record changes might take up to 48 hours to take effect. In the meantime, your application will be accessible from the `ploomber.app` or `ploomberapp.io` URL
147154
```
148155

149156
## Moving an existing domain/subdomain to another app
@@ -190,7 +197,7 @@ These are the most common errors.
190197

191198
![](../static/custom-domains/domains-server-not-found.png)
192199

193-
You'll see this error if you're missing the DNAME record that points from your domain (or subdomain) to the `ID.ploomberapp.io` URL, ensure you add it. Give it some time since DNS records take some time to update. If issues persist, contact us at [contact@ploomber.io](mailto:contact@ploomber.io).
200+
You'll see this error if you're missing the DNAME record that points from your domain (or subdomain) to the `ID.ploomber.app` or `ID.ploomberapp.io` URL (depending on your application domain), ensure you add it. Give it some time since DNS records take some time to update. If issues persist, contact us at [contact@ploomber.io](mailto:contact@ploomber.io).
194201

195202

196203
### Potential Security Risk Ahead

doc/user-guide/password.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,16 @@ edit it by updating the `.env` file. This secret is used to sign your session to
161161
(auth0-urls)=
162162
### Set `/callback` and `/status` URLs
163163

164-
Almost done! We just need to set the `/callback` and `/status` URLs for your Auth0 app. Navigate to your Ploomber project's application page and copy the application URL. It should look like `https://application-name-1999.ploomberapp.io`.
164+
Almost done! We just need to set the `/callback` and `/status` URLs for your Auth0 app. Navigate to your Ploomber project's application page and copy the application URL. It should look like `https://application-name-1999.ploomber.app` or `https://application-name-1999.ploomberapp.io` (depending on your application domain).
165165

166166
Now, go back to the Auth0 application page and scroll down to `Application URIs`. Set these values:
167167

168-
- Allowed Callback URLs: `https://application-name-1999.ploomberapp.io/callback`
169-
- Allows Logout URLs: `https://application-name-1999.ploomberapp.io/status`
168+
- Allowed Callback URLs: `https://application-name-1999.ploomber.app/callback`
169+
- Allows Logout URLs: `https://application-name-1999.ploomber.app/status`
170+
171+
```{important}
172+
We are slowly migrating all new applications to `ploomber.app`, but some existing apps are still on `ploomberapp.io`. Make sure your URLs match the domain associated with your application.
173+
```
170174

171175
It should look like this:
172176

0 commit comments

Comments
 (0)