wala-rust

commit 6f70b604effc21c4e735c09d656d6f1edca5d1a0
parent 3741271abc5b0e73f9012ecf7d305c82197afba8
Author: lash <dev@holbrook.no>
Date:   Wed,  5 Oct 2022 14:36:33 +0000

Link to wala send docs from wala

Diffstat:
A
README
 | 
25
+++++++++++++++++++++++++
M
src/lib.rs
 | 
7
++++++-

2 files changed, 31 insertions(+), 1 deletion(-)
diff --git a/README b/README
@@ -0,0 +1,25 @@
+Build the binaries:
+
+$ cargo build --all-features --release
+
+
+Running the server
+
+$ ./target/release/wala -d <storage_directory>
+
+Logging output detail can be adjusted by setting environment variable RUST_LOG to debug, info, warn or error.
+
+
+Upload the string "foo" using the send tool
+
+$ ./target/release/wala_send -u http://localhost:8000 foo
+
+
+Upload the string "xyzzy" under a mutable reference with keyword "foo" using the send tool:
+
+$ ./target/release/wala_send -u http://localhost:8000 -k <pgp key fingerprint> -i bar xyzzy
+
+
+Note!
+
+Wala is not intended to be used by itself in a production environment. Please consider setting a reverse proxy in front of it.
diff --git a/src/lib.rs b/src/lib.rs
@@ -25,12 +25,17 @@
 //! serve uploaded files from the current directory. This behavior can be modified by the argument
 //! options. See `cargo run -- --help` for details.
 //!
+//! ## Uploading content
+//!
 //! Content is stored by making `PUT` requests to the server. With a server running on
-//! `localhost:8000`a `PUT` with the content body `foo` can in turn be retrieved at:
+//! `localhost:8000` a `PUT` with the content body `foo` can in turn be retrieved at:
 //!
 //! ``` ignore,
 //! http://localhost:8000/2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae 
 //! ```
+//!
+//! A helper tool [wala_send](../wala_send/index.html) is provided to make mutable reference uploads more
+//! convenient.
 
 /// Handle the custom PUBSIG HTTP authentication scheme to generate mutable references.
 pub mod auth;