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.

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

Document custom project names and labels #103

Merged
merged 6 commits into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions doc/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ parts:
- file: user-guide/github
- file: user-guide/env-vars
- file: user-guide/custom-domains
- file: user-guide/managing-apps

- caption: Sharing notebooks
chapters:
Expand Down
Binary file added doc/static/custom-domains/custom-names.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/static/manage-apps/labels.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/static/manage-apps/see-labels-main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/static/manage-apps/see-labels-status.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 20 additions & 1 deletion doc/user-guide/custom-domains.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,28 @@
# Custom domains
# Custom domains and subdomains

When you publish your application for the first time, your web address (i.e., URL) is in the following format: `project-id.plooberapp.io`

Ploomber offers options to customize the [subdomain](#custom-subdomain) or the [full domain](#custom-domain).

If you already own a domain, you can easily bring it to your Ploomber account by updating your DNS records, or by changing its nameservers.

(custom-subdomain)=
## Adding a custom subdomain

```{note}
Custom project names are a [paid feature.](../pricing/overview.md)
```

If you would like a custom subdomain, like `my-custom-app.ploomberapp.io`, you can add a custom name during application setup:

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

Customizing the project name only changes the `x` portion in `x.ploomberapp.io`.

If you would like a fully customized domain, see [Adding a custom domain](#custom-domain).


(custom-domain)=
## Adding a custom domain

### Before you begin
Expand Down
17 changes: 17 additions & 0 deletions doc/user-guide/managing-apps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Managing applications

## Labels

Labels can help you organize and identify your apps. You can add them during creation:

![](../static/manage-apps/labels.png)

Or add them from the application status page:

![](../static/manage-apps/add-label-from-status.png)

You may add as many labels as you want. Once you've added some labels, they will show up on the status page and the main Applications page:

![](../static/manage-apps/see-labels-status.png)

![](../static/manage-apps/see-labels-main.png)