Add README.md for some documentation

This commit is contained in:
Hermsi1337 2017-10-18 08:55:05 +02:00
parent 9d7ac34f64
commit b55a7b4f95

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# Make your OpenSSH fly on Alpine
## Overview
Use this Dockerfile / -image to start a sshd-server upon a lightweight Alpine container. <br>
### Features
* Always installs the latest OpenSSH-Version available for Alpine
* Password of "root"-user can be changed when starting the container using --env
### Basic Usage
```
$ docker run --rm \
--publish=1337:22 --env ROOT_PASSWORD=MyRootPW!23 \
hermsi/alpine-sshd
```
### Use with docker-compose
I built this image in order to use it along with a nginx and fpm-php container for transferring files via sftp. <br>
If you are interested in a Dockerfile which fulfills this need: [this way](https://github.com/Hermsi1337/docker-compose/blob/master/full_php_dev_stack/docker-compose.yml)