From 66d951b0e1272f88b2f27c2a5313c8722b5db35b Mon Sep 17 00:00:00 2001
From: JoshPiper <32164094+JoshPiper@users.noreply.github.com>
Date: Fri, 3 Jan 2020 21:20:58 +0000
Subject: [PATCH] Create README.md

---
 README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bb93c8d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,80 @@
+# rsync docker image.
+
+A simple alpine based docker image for rsync and ssh deployments.
+
+## Using this image
+This image has two primary uses. Firstly, as a deployment image for GitLab CI runs. Secondly, as a base image for other images.
+
+### gitlab-ci.yml
+```yml
+image: drinternet/rsync:1.0.1
+...
+before_script:
+  - source agent-autostart "$CI_PROJECT_ID-$CI_PIPELINE_ID-$_CI_CONCURRENT_ID"
+  - hosts-add "$SSH_KNOWN_HOSTS"
+
+after_script:
+  - agent-stop "$CI_PROJECT_ID-$CI_PIPELINE_ID-$_CI_CONCURRENT_ID"
+```
+
+### Base image in a `Dockerfile
+```dockerfile
+FROM drinternet/rsync:1.0.1
+COPY some/file or/whatever
+```
+
+## Inbuilt commands.
+
+This base image also includes a few shell scripts, to help with managing SSH agents and known hosts files.
+### SSH Agent Management
+#### agent-start
+This command starts the SSH agent, if it isn't already started (SSH_AGENT_PID set or ssh agent ID file found).
+It takes one optional argument, for the name of the agent to be started. Defaults to "default".
+This program needs to be source'd to work correctly.
+`source agent-start "default"`
+
+#### agent-stop
+This command stops the SSH agent, if it is started (SSH_AGENT_PID set or ssh agent ID file found).
+It takes one optional argument, for the name of the agent to be stopped. Defaults to "default".
+`agent-stop "my-agent-name"`
+
+#### agent-add
+This command adds a key to the currently running SSH agent. The key is taken from stdin, and the agent used is that in SSH_AGENT_PID.
+
+#### agent-autoadd
+This command starts the SSH agent and loads the private key from the "SSH_PRIVATE_KEY" environment var. The command takes one optional argument, for the name of the agent to be started. Defaults to "default".
+As with agent-start, this command needs to be sourced.
+
+### known_hosts management
+#### hosts-clear
+This command truncates the known_hosts file and sets its permissions.
+
+#### hosts-add
+This command adds an entry to the known hosts file, and ensures its permissions are correct. It takes one argument, which is the new key to add.
+
+## Tags
+Most numeric tags are simple version numbers for the various scripts. However, there are some special tags.
+staging: The latest build from the master branch.
+*-rc: release candidate builds, nearly ready but might contain small changes.
+*-beta: beta builds, still need testing but shouldn't change too much.
+*-alpha: alpha builds, which are likely to change.
+
+## Example gitlab-ci.yml
+```yml
+image: drinternet/rsync:1.0.1
+
+stages:
+  - deploy
+
+before_script:
+  - source agent-autostart "$CI_PROJECT_ID-$CI_PIPELINE_ID-$_CI_CONCURRENT_ID"
+  - hosts-add "$SSH_KNOWN_HOSTS"
+
+after_script:
+  - agent-stop "$CI_PROJECT_ID-$CI_PIPELINE_ID-$_CI_CONCURRENT_ID"
+
+deploy:
+  stage: deploy
+  script:
+    - rsync -zrSlhaO --chmod=D2775,F664 --delete-after . $FTP_USER@$FTP_HOST:/var/www/deployment/
+```