Skip to content

Commit 112dfd4

Browse files
committed
Reworking docs
1 parent a2e001c commit 112dfd4

File tree

11 files changed

+420
-821
lines changed

11 files changed

+420
-821
lines changed

README.md

Lines changed: 157 additions & 475 deletions
Large diffs are not rendered by default.

docs/README.md

Lines changed: 0 additions & 317 deletions
This file was deleted.

docs/custom-domains.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Custom domains
2+
3+
Custom domains allow users to use their own domains.
4+
5+
>**Note**:
6+
Refer to [custom domains on functions](https://www.scaleway.com/en/docs/compute/functions/how-to/add-a-custom-domain-name-to-a-function/) or
7+
[custom domains on containers](https://www.scaleway.com/en/docs/compute/containers/how-to/add-a-custom-domain-to-a-container/) for more information about domain configuration.
8+
9+
Integration with serverless framework example:
10+
11+
```yaml
12+
functions:
13+
first:
14+
handler: handler.handle
15+
# Local environment variables - used only in given function
16+
env:
17+
local: local
18+
custom_domains:
19+
- func1.scaleway.com
20+
- func2.scaleway.com
21+
```
22+
23+
- >**Note**:
24+
Your domain must have a record pointing to your function hostname. You should deploy your function once to read its hostname. The configuration of custom domains becomes available after the first deploy.
25+
26+
- >**Note:**
27+
Serverless Framework considers the configuration file as the source of truth.
28+
29+
- >**Important**:
30+
If you create a domain with other tools (the Scaleway console, the CLI or APIs) you must refer the created domain into your serverless configuration file. Otherwise it will be deleted as serverless framework will give the priority to its configuration.

0 commit comments

Comments
 (0)