hotfix for user setup guide
This commit is contained in:
parent
9ec4eab173
commit
1705ae08cc
1 changed files with 13 additions and 1 deletions
14
README.md
14
README.md
|
@ -8,7 +8,7 @@ SQLite, PostgreSQL and MYSQL are supported for the database, Authentication can
|
||||||
# Installation
|
# Installation
|
||||||
Start by downloading the tarball from the latest release from the [releases](https://forgejo.fluxgrid.pk/RafayAhmad/flux-sftp/releases), then extract the tarball as follows
|
Start by downloading the tarball from the latest release from the [releases](https://forgejo.fluxgrid.pk/RafayAhmad/flux-sftp/releases), then extract the tarball as follows
|
||||||
```bash
|
```bash
|
||||||
tar -xzvf flux-sftp.tar.gz -C /
|
sudo tar -xzvf flux-sftp.tar.gz -C /
|
||||||
```
|
```
|
||||||
## Database
|
## Database
|
||||||
before you can run the server you need to setup a database, SQLite, PostgreSQL and MYSQL are supported. get a database server running or simply create a sqlite database file and configure the server as mentioned in the [configuration section](#configuration).
|
before you can run the server you need to setup a database, SQLite, PostgreSQL and MYSQL are supported. get a database server running or simply create a sqlite database file and configure the server as mentioned in the [configuration section](#configuration).
|
||||||
|
@ -16,6 +16,18 @@ the database table should have a username field, and optionally public key and p
|
||||||
|
|
||||||
***Note that registering users must be done manually by inserting records into the database as of now.***
|
***Note that registering users must be done manually by inserting records into the database as of now.***
|
||||||
|
|
||||||
|
## User setup
|
||||||
|
create a user named fluxsftp as follows
|
||||||
|
```bash
|
||||||
|
sudo useradd -r -s /usr/sbin/nologin fluxsftp
|
||||||
|
```
|
||||||
|
this user needs to own the jail directory, make sure to change ownership of the jail directory you have specified in the config
|
||||||
|
```bash
|
||||||
|
sudo chown -R fluxsftp:fluxsftp /srv/sftp
|
||||||
|
```
|
||||||
|
|
||||||
|
***When u register a new user make sure to create a directory for them in the jail directory and make sure it is owned by the fluxsftp user***
|
||||||
|
|
||||||
## Enable and Start
|
## Enable and Start
|
||||||
after you have configured the database you can start the server as follows
|
after you have configured the database you can start the server as follows
|
||||||
```bash
|
```bash
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue