19 releases (12 breaking)

Uses new Rust 2021

0.13.0 Sep 17, 2022
0.11.0 Aug 24, 2022

#412 in Database interfaces

46 downloads per month

MIT/Apache

665KB
3K SLoC

Axum-based webserver based on rustdb database, with database browsing, password hashing, database replication, email transmission and timed jobs.

Installation and starting server

First install Rust if it is not already installed. Then install rustweb from a command prompt using

cargo install rustweb

From a command prompt, change to the the directory where the database is to be stored ( the file will be named rustweb.rustdb ). Start rustweb using

rustweb 3000

This should start rustweb server, listening on port 3000 ( you can use any available port ). You should then be able to browse to http://localhost:3000/Menu From there are links to a Manual, Execute SQL, a list of Schemas and other links.

Security

Initially login security is disabled. To enable it

(1) Edit the function login.hash and change the salt string.

(2) Create a record in login.user.

(3) Use the Logins Menu link to set a password.

(4) Edit the function login.get ( see instructions included there ).

Database replication

Start Rustweb in the directory (folder) where you want the replicated database stored, specifying the -rep option

For example:

rustweb 2000 --rep https://mydomain.com

If login security has been enabled, you will need to specify login details ( obtained from the login.user table ), for example:

--login "uid=1; hpw=0xaaa023850abbdff839894888dd8e8abbceaaa023855abbdff839894888dd8e8c"

If the database is very large, it may be more practical to use FTP to get an initial copy of the database, otherwise a copy will be fetched automatically.

Replication is enabled by records being inserted in the log.Transaction table.

These records can be periodically deleted, provided that all replication servers are up to date.

Email

Email can be sent using the email schema.

(1) Create a record in email.SmtpServer

(2) Create an email in email.msg

(3) Insert it into email.Queue

(4) Call the builtin function EMAILTX()

If an email cannot be sent, and the error is temporary, it will be inserted into the email.Delayed table and retried later.

Permanent errors are logged in email.SendError

Timed Jobs

A named SQL function (with no parameters) can be called at a specified time by creating a record in timed.Job.

This is used by the email system to retry temporary email send errors.

Read Only Requests

GET requests are processed using a read-only copy of the database, any changes made are not saved. This is useful for requests that take a significant time to process, as other requests can be processed in parallel. This can be overriden by adding a query parameter "save".

POST requests are assumed to be read-write, this can be overridden by adding a query parameter "readonly".

Arguments and Options

USAGE:
rustweb [OPTIONS]

ARGS:
Port to listen on

OPTIONS:
-h, --help Print help information
-i, --ip Ip Address to listen on [default: 0.0.0.0]
-l, --login Login cookies for replication [default: ]
-m, --mem Memory limit for page cache (in MB) [default: 10]
-r, --rep Server to replicate [default: ]
--tracemem Trace memory trimming
--tracetime Trace query time
-V, --version Print version information

Links

crates.io : https://crates.io/crates/rustweb

repository: https://github.com/georgebarwood/Rustweb

Dependencies

~17–26MB
~546K SLoC