Skip to content

Fix container image name position #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix container image name position #144

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This project provides a Docker image for hosting a SFTP server. Included are `Do
> Supports architectures: `amd64`, `arm` and `arm64`

### Support
If you need help or found a bug, please feel free to open an issue on the [emberstack/docker-sftp](https://github.com/emberstack/docker-sftp) GitHub project.
If you need help or found a bug, please feel free to open an issue on the [emberstack/docker-sftp](https://github.com/emberstack/docker-sftp) GitHub project.

## Usage

Expand Down Expand Up @@ -49,8 +49,8 @@ Below is the simplest configuration file for the SFTP server:
]
}
```
This configuration creates a user `demo` with the password `demo`.
A directory "sftp" is created for each user in the own home and is accessible for read/write.
This configuration creates a user `demo` with the password `demo`.
A directory "sftp" is created for each user in the own home and is accessible for read/write.
The user is `chrooted` to the `/home/demo` directory. Upon connect, the start directory is `sftp`.

You can add additional users, default directories or customize start directories per user. You can also define the `UID` and `GID` for each user. See the `Advanced Configuration` section below for all configuration options.
Expand All @@ -61,21 +61,21 @@ You can add additional users, default directories or customize start directories
> Simple Docker CLI run

```shellsession
$ docker run -p 22:22 -d emberstack/sftp --name sftp
$ docker run -p 22:22 -d --name sftp emberstack/sftp
```
This will start a SFTP in the container `sftp` with the default configuration. You can connect to it and login with the `user: demo` and `password: demo`.

> Provide your configuration

```shellsession
$ docker run -p 22:22 -d emberstack/sftp --name sftp -v /host/sftp.json:/app/config/sftp.json:ro
$ docker run -p 22:22 -d --name sftp -v /host/sftp.json:/app/config/sftp.json:ro emberstack/sftp
```
This will override the default (`/app/config/sftp.json`) configuration with the one from the host `/host/sftp.json`.

> Mount a directory from the host for the user 'demo'

```shellsession
$ docker run -p 22:22 -d emberstack/sftp --name sftp -v /host/sftp.json:/app/config/sftp.json:ro -v /host/demo:/home/demo/sftp
$ docker run -p 22:22 -d --name sftp -v /host/sftp.json:/app/config/sftp.json:ro -v /host/demo:/home/demo/sftp emberstack/sftp
```
This will mount the `demo` directory from the host on the `sftp` directory for the "demo" user.

Expand Down