Added some notes on credentials to the deployment docs
This commit is contained in:
parent
4281159952
commit
c5d828fa00
|
@ -29,7 +29,7 @@ to true.
|
||||||
target = sftp://myuser:mypassword@ftp.example.com/var/www/example
|
target = sftp://myuser:mypassword@ftp.example.com/var/www/example
|
||||||
```
|
```
|
||||||
|
|
||||||
## Note on Credentials
|
## Credentials
|
||||||
|
|
||||||
FTP is considered a largely insecure protocol for Lektor. As such if you
|
FTP is considered a largely insecure protocol for Lektor. As such if you
|
||||||
want to use it you should keep your project file save as credentials will
|
want to use it you should keep your project file save as credentials will
|
||||||
|
|
|
@ -15,15 +15,25 @@ The way this is implemented in Lektor currently is that Lektor will force-push
|
||||||
a website into a repository of choice. There are two ways to push it up:
|
a website into a repository of choice. There are two ways to push it up:
|
||||||
`ghpages` (which uses SSH) or `ghpages+https` (which uses HTTPS). The latter
|
`ghpages` (which uses SSH) or `ghpages+https` (which uses HTTPS). The latter
|
||||||
can also accept `username:password@` in the URL to hold the credentials in
|
can also accept `username:password@` in the URL to hold the credentials in
|
||||||
addition to accepting username and password from the command line.
|
addition to accepting username and password from the command line or
|
||||||
|
environment variables.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
[servers.production]
|
[servers.ghpages]
|
||||||
target = ghpages://your-user/your-repository
|
target = ghpages://your-user/your-repository
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Credentials
|
||||||
|
|
||||||
|
This deployment method has two implementations: `ghpages` (also known as
|
||||||
|
`ghpages+ssh`) which uses SSH and `ghpages+https` which uses HTTPS. They
|
||||||
|
use different methods for credentials. For the SSH transport the same
|
||||||
|
rules apply as for the [rsync deployment method :ref](../rsync/). The HTTPS
|
||||||
|
transport on the other hand accepts `--username` and `--password` which
|
||||||
|
override the values in the URL.
|
||||||
|
|
||||||
## Behavior
|
## Behavior
|
||||||
|
|
||||||
The way this deployment support works is that it commits a new commit into a
|
The way this deployment support works is that it commits a new commit into a
|
||||||
|
|
|
@ -20,7 +20,7 @@ as default from the `.ssh/config`.
|
||||||
target = rsync://deploy@example.com/var/www/example.com
|
target = rsync://deploy@example.com/var/www/example.com
|
||||||
```
|
```
|
||||||
|
|
||||||
## Note on Credentials
|
## Credentials
|
||||||
|
|
||||||
The `rsync` deploy method supports both username and password parameter
|
The `rsync` deploy method supports both username and password parameter
|
||||||
though it's recommended to use `.ssh/config` and an SSH agent to secure
|
though it's recommended to use `.ssh/config` and an SSH agent to secure
|
||||||
|
|
Loading…
Reference in New Issue