initial import

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3da6105
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# installation
+
+ * compile minor-skulk with `cargo build`.
+ * edit `Rocket.toml`, settings values for all the mandatory parameters
+   * for test deployments it's sufficient to use the http server provided by
+     minor-skulk. live deployments **must** use a reverse proxy to add TLS!
+ * install [syncstorage-rs](https://github.com/mozilla-services/syncstorage-rs)
+ * configure syncstorage-rs for a single-node setup as exemplified in
+   [this nixos module](https://github.com/NixOS/nixpkgs/pull/176835).
+   you will also have to set `tokenserver.fxa_oauth_server_url` as
+   noted in `Rocket.toml`, otherwise actual sync will not work.
+
+# configuring firefox desktop
+
+go to `about:config` and set `identity.fxaccounts.autoconfig.uri` to
+the address of your server, e.g. `http://localhost:8000` if you're just
+starting minor-skulk locally for testing. if you are not using https you
+must also create a `identity.fxaccounts.allowHttp` settings with value `true`,
+otherwise firefox will not accept the config. restart firefox for the
+changes to take effect, then create an account or log in as usual.
+
+# configuring firefox android
+
+this is a sufficiently involved process that the web interface has a 
+dedicated guide. just open the url of your server in firefox on android
+and follow the guide. ("just". we're so sorry.)