Skip to content

Commit

Permalink
Ploomber Cloud deployment documentation (#6182)
Browse files Browse the repository at this point in the history
  • Loading branch information
neelasha23 authored Jan 12, 2024
1 parent 0b7f691 commit 07fd37b
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 0 deletions.
Binary file added doc/_static/images/ploomber_deployment.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/logos/ploomber.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions doc/how_to/deployment/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ For guides on running and configuring a Panel server see the [server how-to guid
![Hugging Face Logo](../../_static/logos/huggingface.png)
:::

:::{grid-item-card} Ploomber Cloud
:link: ploomber
:link-type: doc

![Ploomber Logo](../../_static/logos/ploomber.png)
:::

::::

## Other Cloud Providers
Expand Down
49 changes: 49 additions & 0 deletions doc/how_to/deployment/ploomber.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Ploomber Cloud

Ploomber Cloud offers a [free deployment](https://platform.ploomber.io) option for Panel apps. Once you create an account and log in, follow these steps for deploying using the web application:

1. Click on the "NEW" button. You'll find the below page:

<img src="../../_static/images/ploomber_deployment.png" style="width:67%"></img>

2. In the "Framework" section, click on Panel.
3. In the "Source code" section, click on "Upload your files".
4. Upload your `.zip` file with the `app.py` and `requirements.txt` file.
5. Click on "CREATE"
6. Wait until deployment finishes. To see your app, click on the `VIEW APPLICATION` button.


Full instructions for deploying Panel apps are available [here](https://docs.cloud.ploomber.io/en/latest/apps/panel.html).

You can also deploy the panel app using the Ploomber command line interface by following the below steps:

1. First, install the package:

```bash
pip install ploomber-cloud
```

2. Get an [API Key](https://docs.cloud.ploomber.io/en/latest/quickstart/apikey.html) and set the key:

```bash
ploomber-cloud key YOURKEY
```

3. `cd` into the panel app folder that you want to deploy.
4. Initialize your project:

```bash
ploomber-cloud init
```

5. This will prompt you for the project type. You need to enter `panel`.
6. Once your project is configured it will generate a `ploomber-cloud.json` with the project info.
7. Deploy the project by running:

```bash
ploomber-cloud deploy
```

8. To view your application, login to the web application and click on the `VIEW APPLICATION` button.

Full instructions for deploying apps using the CLI are available [here](https://docs.cloud.ploomber.io/en/latest/user-guide/cli.html).

0 comments on commit 07fd37b

Please sign in to comment.