Skip to content

Commit

Permalink
update maintainer information for this fork
Browse files Browse the repository at this point in the history
  • Loading branch information
strebitz committed Mar 24, 2020
1 parent 13926b1 commit a345a11
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 12 deletions.
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# SFTP-Server

[![Ansible Role](https://img.shields.io/ansible/role/991.svg)](https://galaxy.ansible.com/johanmeiring/sftp-server/) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-round)](https://github.com/johanmeiring/ansible-sftp/blob/master/LICENSE) [![Build Status](https://travis-ci.com/johanmeiring/ansible-sftp.svg?branch=master)](https://travis-ci.com/johanmeiring/ansible-sftp)
# Ansible role SFTP-Server

An Ansible role which configures an OpenSSH server for chrooted SFTP access. The role is built in such a way that it will not unnecessarily alter a user's OpenSSH customisations. Instead, it simply changes the crucial bits that it needs to, and adds the rest of its configuration in the form of a custom config block (OpenSSH's lack of some form of conf.d/ support forces this behaviour).

Expand All @@ -25,7 +23,7 @@ The following role variables are relevant:
* `sftp_group_name`: The name of the Unix group to which all SFTP users must belong. Defaults to "sftpusers".
* `sftp_directories`: A list of directories that need to be created automatically by default for all SFTP user. Defaults to a blank list (i.e. "[]").
* Values can be plain strings, or dictionaries containing `name` and (optionally) `mode` key/value pairs.
* `sftp_start_directory`: A directory that need to be part of sftp_directories values and that is the start directory of new sftp connection. Disable by default with an empty string value.
* `sftp_start_directory`: A directory that need to be part of sftp\_directories values and that is the start directory of new sftp connection. Disable by default with an empty string value.
* `sftp_allow_passwords`: Whether or not to allow password authentication for SFTP. Defaults to False.
* `sftp_enable_selinux_support`: Whether or not to explicitly enable SELinux support. Defaults to False.
* `sftp_enable_logging`: Enable logging. Auth logs will be written to `/var/log/sftp/auth.log`, and SFTP activity logs will be written to `/var/log/sftp/verbose.log`. Defaults to False.
Expand All @@ -44,7 +42,7 @@ The following role variables are relevant:

Notes:

* The `sftp_nologin_shell` setting defines the shell assigned to sftp_users when the sftp user's shell is set to False. (The nologin shell ensures the user may only use SFTP and have no other login permissions.) This value may vary depending on the operating system version.
* The `sftp_nologin_shell` setting defines the shell assigned to sftp\_users when the sftp user's shell is set to False. (The nologin shell ensures the user may only use SFTP and have no other login permissions.) This value may vary depending on the operating system version.

## Example Playbook

Expand Down Expand Up @@ -80,9 +78,3 @@ Notes:
This Ansible role is distributed under the MIT License. See the LICENSE file for more details.
## Donations
Donations are very welcome, and can be made to the following addresses:
* BTC: 1AWHJcUBha35FnuuWat9urRW2FNc4ftztv
* ETH: 0xAF1Aac4c40446F4C46e55614F14d9b32d712ECBc
3 changes: 2 additions & 1 deletion meta/main.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
galaxy_info:
role_name: sftp-server
description: Setup chrooted SFTP service on top of OpenSSH
author: Johan Meiring
description: "Setup chrooted SFTP service on top of OpenSSH"
license: MIT
min_ansible_version: 2.5

Expand Down

0 comments on commit a345a11

Please sign in to comment.