From 7de253ead762dc408ab43ba742bbaf35dc70eae3 Mon Sep 17 00:00:00 2001
From: RafayAhmad7548 <rafayahmad1425@gmail.com>
Date: Thu, 10 Jul 2025 17:53:41 +0500
Subject: [PATCH] added readme

---
 .gitignore |  1 +
 README.md  | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index b7cc3ac..5f576bc 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
 /target
+pkg/
 sftptest
 sftptest.pub
 server
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8fe4ce4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# Overview
+FluxSFTP is a regular SFTP server with the following additions:
+* custom authentication (virtual users)
+* jail directories i.e. limit users to a certain directory
+
+SQLite, PostgreSQL and MYSQL are supported for the database, Authentication can be done either via public key or password, password authentication uses bcrypt hashing with the default cost i.e. 12
+
+# Installation
+
+
+# Configuration
+The configuration file is located at `/etc/flux-sftp/config.toml`, here is the default configuration:
+
+```toml
+[general]
+listen_address = "0.0.0.0"
+port = 2222
+jail_dir = "/srv/sftp"
+private_key_file = "~/.ssh/flux-sftp"
+
+[database]
+driver = "sqlite"
+path = "/var/lib/flux-sftp/auth.db"
+# host = "127.0.0.1"
+# port = 3306
+# user = "testuser"
+# password = "testpass"
+# dbname = "testdb"
+table = "users"
+username_field = "username"
+public_key_field = "public_key"
+# password_field = "password"
+```
+
+## Options
+### general
+* `listen_address` the address that the server listens on
+* `port` the port that the server listens on
+* `jail_dir` the directory that the all the users will be jailed into, each user will be jailed to the directory `jail_dir/{username}`, e.g. example_user will be jailed to `/srv/sftp/example_user` if `jail_dir` is set to `/srv/sftp`
+* `private_key_file` the private key for the server, the server will use this to present its identity
+### database
+* `driver` which database to use, can be `sqlite`, `postgres`, `mysql`. in case of sqlite `path` option must be specified and for `postgres` and `mysql` the relevant options to connect to the database must be specified
+* `path` path to sqlite db file, only specify if using `sqlite`
+* `host` host address for the database, only specify if using `postgres` or `mysql`
+* `port` port the database server is running on, only specify if using `postgres` or `mysql`
+* `user` database user, only specify if using `postgres` or `mysql`
+* `password` password for the database user, only specify if using `postgres` or `mysql`
+* `dbname` name of the database to use, only specify if using `postgres` or `mysql`
+* `table` the database table to query to get the hashed password or the public_key
+* `username_field` name of the database column which stores the username
+* `public_key_field` name of the database column which stores the public key, if this is not specifed this auth method will be disabled rejecting all requests
+* `password_field` name of the database column which stores the hashed password, if this is not specifed this auth method will be disabled rejecting all requests
+