-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
43 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,19 @@ | ||
# Automatic TLS | ||
|
||
Pageship supports automatic TLS through [certmagic](https://github.com/caddyserver/certmagic) library. | ||
|
||
Automatic TLS can be activated by passing `--tls` command line parameter. | ||
Certificates would be obtained from Let's Encrypt when a site domain is accessed | ||
for the first time. It is recommnded to provide a email to receive notifications | ||
from certificate issuer using `--tls-acme-email` command line parameter. | ||
|
||
## Certificate Persistence | ||
|
||
In single-site & unmanaged-sites mode, certificate data is stored on the default | ||
filesystem directory specified by `certmagic` library | ||
(`${XDG_DATA_HOME}/certmagic`) in plain-text. Care should be taken to secure | ||
the key materials. | ||
|
||
In managed sites mode, certificate data is stored in database. Optionally, an | ||
encryption key can be specified through `--tls-protect-key` parameter to | ||
encrypt the certificate data at rest using NaCL secretbox. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,25 @@ | ||
# Preview Deployment | ||
|
||
Pageship supports preview deployments. When a deployment is created without | ||
assigning to a site, it is treated as preview deployments. | ||
|
||
Preview deployments has limited lifetime, and expires after a period not | ||
assigned to a site. This period can be configured in `pageship.toml`: | ||
```toml | ||
[app.deployments] | ||
ttl = "24h" # expires after 24 hours. | ||
``` | ||
|
||
An expired preview deployment is inaccessible and deleted automatically after | ||
some time. | ||
|
||
## Access Control | ||
|
||
By default, preview deployments are not accessible. To enable access to | ||
preview deployments, setup access control for preview deployment in `pageship.toml`: | ||
```toml | ||
[app.deployments] | ||
access = [ | ||
{ ipRange="0.0.0.0/0" } # preview deployments are accessible to anyone. | ||
] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters