Skip to content

Commit 7a16269

Browse files
bene2k1nerda-codesRoRoJ
authored
Apply suggestions from code review
Co-authored-by: Néda <[email protected]> Co-authored-by: Rowena Jones <[email protected]>
1 parent 6e673c0 commit 7a16269

File tree

1 file changed

+23
-22
lines changed
  • tutorials/deploy-openwebui-with-generative-apis

1 file changed

+23
-22
lines changed

tutorials/deploy-openwebui-with-generative-apis/index.mdx

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Open WebUI is an open-source frontend that simplifies interactions with AI model
1919
This tutorial will guide you through:
2020

2121
- Configuring Generative APIs on Scaleway
22-
- Installing Open WebUI Locally
23-
- Deploying Open WebUI Using Scaleway's Serverless Containers
22+
- Installing Open WebUI locally
23+
- Deploying Open WebUI using Scaleway's Serverless Containers
2424

2525

2626
By the end, you'll have a fully functional AI-powered setup.
@@ -35,17 +35,17 @@ By the end, you'll have a fully functional AI-powered setup.
3535

3636
## Configuring Generative APIs on Scaleway
3737

38-
Scaleway's Generative APIs provide access to advanced AI models via simple API calls. To set up:
38+
Scaleway's Generative APIs provide access to advanced AI models via simple API calls. Follow the instructions below to set up Generative APIs
3939

4040
### Creating an API key
4141

42-
1. Log in to the [Scaleway Console](https://console.scaleway.com/).
42+
1. Log in to the [Scaleway console](https://console.scaleway.com/).
4343
2. Click on your **Organization name** in the top right corner of the console to display the menu.
4444
3. Click **API keys** in the pop-up menu.
4545
4. Click **Generate a New API Key**, provide a name, and store the key securely.
4646

4747
<Message type="tip">
48-
For detailed information about creating API keys, refer to [How to create API keys](/iam/how-to/create-api-keys/).
48+
For detailed information about creating API keys, refer to the [how to create API keys documentation](/iam/how-to/create-api-keys/).
4949
</Message>
5050

5151
### Identifying the API endpoint
@@ -56,11 +56,11 @@ Scaleway assigns a unique endpoint for your Generative API access. This can be f
5656
https://api.scaleway.ai/<YOUR_PROJECT_ID>/v1
5757
```
5858

59-
If you have not created a dedicated project and are using the `default` project created with your Scaleway Account, you can use directly the following url: `https://api.scaleway.ai/v1`.
60-
You can also find the exact URL snippet including your `project_id` by visiting [Generative API Playground](https://console.scaleway.com/generative-api/models/fr-par/playground) and clicking on `View Code`.
59+
If you have not created a dedicated Project and are using the `default` Project created with your Scaleway account, you can use the following url: `https://api.scaleway.ai/v1`.
60+
You can also find the exact URL snippet including your `project_id` by visiting the [Generative API Playground](https://console.scaleway.com/generative-api/models/fr-par/playground) and clicking **View Code**.
6161

6262
<Message type="note">
63-
For more information about your Project ID, refer to our [dedicated documentation](/organizations-and-projects/how-to/create-a-project/).
63+
Refer to our [dedicated documentation](/organizations-and-projects/how-to/create-a-project/) to retrieve your Project ID.
6464
</Message>
6565

6666
## Installing Open WebUI locally
@@ -69,7 +69,7 @@ Open WebUI provides an easy-to-use interface for interacting with AI models. The
6969

7070
### Running Open WebUI with Scaleway integration
7171

72-
1. Pull and Run the Docker container:
72+
1. Pull and run the Docker container:
7373

7474
```bash
7575
docker run -p 3000:8080 \
@@ -88,48 +88,49 @@ Open WebUI provides an easy-to-use interface for interacting with AI models. The
8888
2. Navigate to `http://localhost:3000` in your browser to access the Open WebUI interface.
8989

9090
3. Click **Sign Up** to create an administrator account.
91-
4. Select a Model from the available Scaleway AI models and start interacting.
91+
4. Select a model from the available Scaleway AI models and start interacting.
9292

9393
For more details, refer to the [Open WebUI Quick Start Guide](https://docs.openwebui.com/getting-started/quick-start/).
9494

95-
## Deploying Open WebUI Using Scaleway's Serverless Containers (Optional)
95+
## Deploying Open WebUI using Scaleway's Serverless Containers (Optional)
9696

9797
For cloud-based deployment, Scaleway's Serverless Containers offer a scalable solution.
9898

9999
### Deploying on Scaleway via the console
100100

101-
1. In the Scaleway Console, navigate to **Serverless** > **Containers**.
101+
1. In the Scaleway console, navigate to **Serverless** > **Containers**.
102102
2. Click **Deploy Container** to display the container creation wizard.
103-
3. Select an external registry and use the image `ghcr.io/open-webui/open-webui:main`.
103+
3. Select an external registry and use the `ghcr.io/open-webui/open-webui:main` image.
104104
<Message type="note">
105-
You do not need to configure the port as the default one - `8080` - is the one used by the image from `ghcr.io/open-webui/open-webui:main`.
105+
You do not need to configure the port as the default one as `8080` is the one used by the image from `ghcr.io/open-webui/open-webui:main`.
106106
</Message>
107-
4. Enter a name for your container and configure it's resources.
108-
5. Click **Advanced options** and configure Secrets:
107+
4. Enter a name for your container and configure its resources.
108+
5. Click **Advanced options** and configure secrets:
109109
- Set `OPENAI_API_BASE_URL` and `OPENAI_API_KEY` with your specific values.
110110

111111
6. Click **Deploy container** to launch deployment. Once deployed, note the provided endpoint to access Open WebUI.
112112

113113
<Message type="note">
114-
Since Open WebUI default image is around 5GB size, deployment can take a couple of minutes before being ready.
114+
Since the Open WebUI default image is around 5GB size, deployment can take a couple of minutes before being ready.
115115
</Message>
116116

117117
### Deploying on Scaleway using the ClI
118118

119-
#### Ensure your Scaleway namespace exists
119+
#### Ensure you have a Scaleway Serverless Containers namespace
120120

121-
Scaleway Serverless Containers are deployed inside a **namespace**. If you do not have one, create it first:
121+
Scaleway Serverless Containers are deployed inside a **namespace**. Run the following command to create a namespace:
122122

123123
```bash
124124
scw container namespace create name=openwebui-ns region=fr-par
125125
```
126-
Find the namespace ID:
126+
Run the following command to retrieve the namespace ID:
127127
```bash
128128
scw container namespace list
129129
```
130130

131131
### Create the Serverless Container
132-
Now, create the container with your **Docker image and secret injection**:
132+
133+
Run the following command to create the container with your **Docker image and secret injection**:
133134

134135
```bash
135136

@@ -146,4 +147,4 @@ $ scw container container create name=open-webui \
146147
Replace `<YOUR_PROJECT_ID>` and `<YOUR_API_KEY>` with your actual values.
147148
</Message>
148149

149-
For more details, refer to Scaleway's [Serverless Containers documentation](/serverless-containers/).
150+
For more information, refer to Scaleway's [Serverless Containers documentation](/serverless-containers/).

0 commit comments

Comments
 (0)