From c5d828fa00843e206b69437b56a5ae92eda9b834 Mon Sep 17 00:00:00 2001 From: Armin Ronacher Date: Sat, 19 Dec 2015 19:07:03 +0100 Subject: [PATCH] Added some notes on credentials to the deployment docs --- content/docs/deployment/ftp/contents.lr | 2 +- content/docs/deployment/ghpages/contents.lr | 14 ++++++++++++-- content/docs/deployment/rsync/contents.lr | 2 +- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/content/docs/deployment/ftp/contents.lr b/content/docs/deployment/ftp/contents.lr index 3eadd130..bde0c734 100644 --- a/content/docs/deployment/ftp/contents.lr +++ b/content/docs/deployment/ftp/contents.lr @@ -29,7 +29,7 @@ to true. 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 want to use it you should keep your project file save as credentials will diff --git a/content/docs/deployment/ghpages/contents.lr b/content/docs/deployment/ghpages/contents.lr index 2592d066..3ebf7171 100644 --- a/content/docs/deployment/ghpages/contents.lr +++ b/content/docs/deployment/ghpages/contents.lr @@ -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: `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 -addition to accepting username and password from the command line. +addition to accepting username and password from the command line or +environment variables. Example: ```ini -[servers.production] +[servers.ghpages] 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 The way this deployment support works is that it commits a new commit into a diff --git a/content/docs/deployment/rsync/contents.lr b/content/docs/deployment/rsync/contents.lr index d1e0e8c6..852f9ff9 100644 --- a/content/docs/deployment/rsync/contents.lr +++ b/content/docs/deployment/rsync/contents.lr @@ -20,7 +20,7 @@ as default from the `.ssh/config`. target = rsync://deploy@example.com/var/www/example.com ``` -## Note on Credentials +## Credentials The `rsync` deploy method supports both username and password parameter though it's recommended to use `.ssh/config` and an SSH agent to secure