diff --git a/README.md b/README.md index 5b0c1b5..19b921c 100644 --- a/README.md +++ b/README.md @@ -50,27 +50,21 @@ git clone https://github.com/Start9Labs/documentation.git && cd documentation git submodule update --init ``` -3. (Optional, if you have an older build that needs to be updated) Navigate to `sphinx-scylladb-theme`, update and build with: - -``` -cd sphinx-scylladb-theme -git pull -npm i -npm run build -``` - -4. Navigate to the `site` folder and start the project: +3. Navigate to the `site` folder and start the project: ``` cd site make clean && make preview ``` + ## Development When editing these files, begin a livereload environment by running `make preview` while in the `./site/` directory. When editing any css or table of contents organization changes, the livereload environment must be ended and `make clean` run before starting `make preview` again. +If you edit something inside `sphinx-scylladb-theme`, you will need to `cd` into that directory and run `npm run build`. + ### Versioning - Build for versioning (must be on master) branch: `make multiversion` - To view version metadata: `make multiversionpreview` diff --git a/poetry.lock b/poetry.lock index bf89bea..d644807 100644 --- a/poetry.lock +++ b/poetry.lock @@ -169,11 +169,11 @@ tornado = {version = "*", markers = "python_version > \"2.7\""} [[package]] name = "markupsafe" -version = "2.0.1" +version = "2.1.0" description = "Safely add untrusted strings to HTML/XML markup." category = "main" optional = false -python-versions = ">=3.6" +python-versions = ">=3.7" [[package]] name = "more-itertools" @@ -684,75 +684,46 @@ livereload = [ {file = "livereload-2.6.3.tar.gz", hash = "sha256:776f2f865e59fde56490a56bcc6773b6917366bce0c267c60ee8aaf1a0959869"}, ] markupsafe = [ - {file = "MarkupSafe-2.0.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:d8446c54dc28c01e5a2dbac5a25f071f6653e6e40f3a8818e8b45d790fe6ef53"}, - {file = "MarkupSafe-2.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:36bc903cbb393720fad60fc28c10de6acf10dc6cc883f3e24ee4012371399a38"}, - {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2d7d807855b419fc2ed3e631034685db6079889a1f01d5d9dac950f764da3dad"}, - {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:add36cb2dbb8b736611303cd3bfcee00afd96471b09cda130da3581cbdc56a6d"}, - {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:168cd0a3642de83558a5153c8bd34f175a9a6e7f6dc6384b9655d2697312a646"}, - {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:4dc8f9fb58f7364b63fd9f85013b780ef83c11857ae79f2feda41e270468dd9b"}, - {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:20dca64a3ef2d6e4d5d615a3fd418ad3bde77a47ec8a23d984a12b5b4c74491a"}, - {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:cdfba22ea2f0029c9261a4bd07e830a8da012291fbe44dc794e488b6c9bb353a"}, - {file = "MarkupSafe-2.0.1-cp310-cp310-win32.whl", hash = "sha256:99df47edb6bda1249d3e80fdabb1dab8c08ef3975f69aed437cb69d0a5de1e28"}, - {file = "MarkupSafe-2.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:e0f138900af21926a02425cf736db95be9f4af72ba1bb21453432a07f6082134"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:f9081981fe268bd86831e5c75f7de206ef275defcb82bc70740ae6dc507aee51"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:0955295dd5eec6cb6cc2fe1698f4c6d84af2e92de33fbcac4111913cd100a6ff"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:0446679737af14f45767963a1a9ef7620189912317d095f2d9ffa183a4d25d2b"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2010_i686.whl", hash = "sha256:f826e31d18b516f653fe296d967d700fddad5901ae07c622bb3705955e1faa94"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2010_x86_64.whl", hash = "sha256:fa130dd50c57d53368c9d59395cb5526eda596d3ffe36666cd81a44d56e48872"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:905fec760bd2fa1388bb5b489ee8ee5f7291d692638ea5f67982d968366bef9f"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bf5d821ffabf0ef3533c39c518f3357b171a1651c1ff6827325e4489b0e46c3c"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:0d4b31cc67ab36e3392bbf3862cfbadac3db12bdd8b02a2731f509ed5b829724"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:baa1a4e8f868845af802979fcdbf0bb11f94f1cb7ced4c4b8a351bb60d108145"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:deb993cacb280823246a026e3b2d81c493c53de6acfd5e6bfe31ab3402bb37dd"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:63f3268ba69ace99cab4e3e3b5840b03340efed0948ab8f78d2fd87ee5442a4f"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:8d206346619592c6200148b01a2142798c989edcb9c896f9ac9722a99d4e77e6"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-win32.whl", hash = "sha256:6c4ca60fa24e85fe25b912b01e62cb969d69a23a5d5867682dd3e80b5b02581d"}, - {file = "MarkupSafe-2.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:b2f4bf27480f5e5e8ce285a8c8fd176c0b03e93dcc6646477d4630e83440c6a9"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:0717a7390a68be14b8c793ba258e075c6f4ca819f15edfc2a3a027c823718567"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:6557b31b5e2c9ddf0de32a691f2312a32f77cd7681d8af66c2692efdbef84c18"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:49e3ceeabbfb9d66c3aef5af3a60cc43b85c33df25ce03d0031a608b0a8b2e3f"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2010_i686.whl", hash = "sha256:d7f9850398e85aba693bb640262d3611788b1f29a79f0c93c565694658f4071f"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2010_x86_64.whl", hash = "sha256:6a7fae0dd14cf60ad5ff42baa2e95727c3d81ded453457771d02b7d2b3f9c0c2"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:b7f2d075102dc8c794cbde1947378051c4e5180d52d276987b8d28a3bd58c17d"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e9936f0b261d4df76ad22f8fee3ae83b60d7c3e871292cd42f40b81b70afae85"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:2a7d351cbd8cfeb19ca00de495e224dea7e7d919659c2841bbb7f420ad03e2d6"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:60bf42e36abfaf9aff1f50f52644b336d4f0a3fd6d8a60ca0d054ac9f713a864"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:d6c7ebd4e944c85e2c3421e612a7057a2f48d478d79e61800d81468a8d842207"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:f0567c4dc99f264f49fe27da5f735f414c4e7e7dd850cfd8e69f0862d7c74ea9"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:89c687013cb1cd489a0f0ac24febe8c7a666e6e221b783e53ac50ebf68e45d86"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-win32.whl", hash = "sha256:a30e67a65b53ea0a5e62fe23682cfe22712e01f453b95233b25502f7c61cb415"}, - {file = "MarkupSafe-2.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:611d1ad9a4288cf3e3c16014564df047fe08410e628f89805e475368bd304914"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:5bb28c636d87e840583ee3adeb78172efc47c8b26127267f54a9c0ec251d41a9"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:be98f628055368795d818ebf93da628541e10b75b41c559fdf36d104c5787066"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux1_i686.whl", hash = "sha256:1d609f577dc6e1aa17d746f8bd3c31aa4d258f4070d61b2aa5c4166c1539de35"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:7d91275b0245b1da4d4cfa07e0faedd5b0812efc15b702576d103293e252af1b"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2010_i686.whl", hash = "sha256:01a9b8ea66f1658938f65b93a85ebe8bc016e6769611be228d797c9d998dd298"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2010_x86_64.whl", hash = "sha256:47ab1e7b91c098ab893b828deafa1203de86d0bc6ab587b160f78fe6c4011f75"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:97383d78eb34da7e1fa37dd273c20ad4320929af65d156e35a5e2d89566d9dfb"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6fcf051089389abe060c9cd7caa212c707e58153afa2c649f00346ce6d260f1b"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:5855f8438a7d1d458206a2466bf82b0f104a3724bf96a1c781ab731e4201731a"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:3dd007d54ee88b46be476e293f48c85048603f5f516008bee124ddd891398ed6"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:aca6377c0cb8a8253e493c6b451565ac77e98c2951c45f913e0b52facdcff83f"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:04635854b943835a6ea959e948d19dcd311762c5c0c6e1f0e16ee57022669194"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:6300b8454aa6930a24b9618fbb54b5a68135092bc666f7b06901f897fa5c2fee"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-win32.whl", hash = "sha256:023cb26ec21ece8dc3907c0e8320058b2e0cb3c55cf9564da612bc325bed5e64"}, - {file = "MarkupSafe-2.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:984d76483eb32f1bcb536dc27e4ad56bba4baa70be32fa87152832cdd9db0833"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:2ef54abee730b502252bcdf31b10dacb0a416229b72c18b19e24a4509f273d26"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:3c112550557578c26af18a1ccc9e090bfe03832ae994343cfdacd287db6a6ae7"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux1_i686.whl", hash = "sha256:53edb4da6925ad13c07b6d26c2a852bd81e364f95301c66e930ab2aef5b5ddd8"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:f5653a225f31e113b152e56f154ccbe59eeb1c7487b39b9d9f9cdb58e6c79dc5"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2010_i686.whl", hash = "sha256:4efca8f86c54b22348a5467704e3fec767b2db12fc39c6d963168ab1d3fc9135"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2010_x86_64.whl", hash = "sha256:ab3ef638ace319fa26553db0624c4699e31a28bb2a835c5faca8f8acf6a5a902"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:f8ba0e8349a38d3001fae7eadded3f6606f0da5d748ee53cc1dab1d6527b9509"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c47adbc92fc1bb2b3274c4b3a43ae0e4573d9fbff4f54cd484555edbf030baf1"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:37205cac2a79194e3750b0af2a5720d95f786a55ce7df90c3af697bfa100eaac"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:1f2ade76b9903f39aa442b4aadd2177decb66525062db244b35d71d0ee8599b6"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:4296f2b1ce8c86a6aea78613c34bb1a672ea0e3de9c6ba08a960efe0b0a09047"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f02365d4e99430a12647f09b6cc8bab61a6564363f313126f775eb4f6ef798e"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5b6d930f030f8ed98e3e6c98ffa0652bdb82601e7a016ec2ab5d7ff23baa78d1"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-win32.whl", hash = "sha256:10f82115e21dc0dfec9ab5c0223652f7197feb168c940f3ef61563fc2d6beb74"}, - {file = "MarkupSafe-2.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:693ce3f9e70a6cf7d2fb9e6c9d8b204b6b39897a2c4a1aa65728d5ac97dcc1d8"}, - {file = "MarkupSafe-2.0.1.tar.gz", hash = "sha256:594c67807fb16238b30c44bdf74f36c02cdf22d1c8cda91ef8a0ed8dabf5620a"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:3028252424c72b2602a323f70fbf50aa80a5d3aa616ea6add4ba21ae9cc9da4c"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:290b02bab3c9e216da57c1d11d2ba73a9f73a614bbdcc027d299a60cdfabb11a"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6e104c0c2b4cd765b4e83909cde7ec61a1e313f8a75775897db321450e928cce"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:24c3be29abb6b34052fd26fc7a8e0a49b1ee9d282e3665e8ad09a0a68faee5b3"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:204730fd5fe2fe3b1e9ccadb2bd18ba8712b111dcabce185af0b3b5285a7c989"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:d3b64c65328cb4cd252c94f83e66e3d7acf8891e60ebf588d7b493a55a1dbf26"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:96de1932237abe0a13ba68b63e94113678c379dca45afa040a17b6e1ad7ed076"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:75bb36f134883fdbe13d8e63b8675f5f12b80bb6627f7714c7d6c5becf22719f"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-win32.whl", hash = "sha256:4056f752015dfa9828dce3140dbadd543b555afb3252507348c493def166d454"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-win_amd64.whl", hash = "sha256:d4e702eea4a2903441f2735799d217f4ac1b55f7d8ad96ab7d4e25417cb0827c"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:f0eddfcabd6936558ec020130f932d479930581171368fd728efcfb6ef0dd357"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5ddea4c352a488b5e1069069f2f501006b1a4362cb906bee9a193ef1245a7a61"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:09c86c9643cceb1d87ca08cdc30160d1b7ab49a8a21564868921959bd16441b8"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a0a0abef2ca47b33fb615b491ce31b055ef2430de52c5b3fb19a4042dbc5cadb"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:736895a020e31b428b3382a7887bfea96102c529530299f426bf2e636aacec9e"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:679cbb78914ab212c49c67ba2c7396dc599a8479de51b9a87b174700abd9ea49"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:84ad5e29bf8bab3ad70fd707d3c05524862bddc54dc040982b0dbcff36481de7"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-win32.whl", hash = "sha256:8da5924cb1f9064589767b0f3fc39d03e3d0fb5aa29e0cb21d43106519bd624a"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-win_amd64.whl", hash = "sha256:454ffc1cbb75227d15667c09f164a0099159da0c1f3d2636aa648f12675491ad"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:142119fb14a1ef6d758912b25c4e803c3ff66920635c44078666fe7cc3f8f759"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:b2a5a856019d2833c56a3dcac1b80fe795c95f401818ea963594b345929dffa7"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1d1fb9b2eec3c9714dd936860850300b51dbaa37404209c8d4cb66547884b7ed"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:62c0285e91414f5c8f621a17b69fc0088394ccdaa961ef469e833dbff64bd5ea"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fc3150f85e2dbcf99e65238c842d1cfe69d3e7649b19864c1cc043213d9cd730"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:f02cf7221d5cd915d7fa58ab64f7ee6dd0f6cddbb48683debf5d04ae9b1c2cc1"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:d5653619b3eb5cbd35bfba3c12d575db2a74d15e0e1c08bf1db788069d410ce8"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:7d2f5d97fcbd004c03df8d8fe2b973fe2b14e7bfeb2cfa012eaa8759ce9a762f"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-win32.whl", hash = "sha256:3cace1837bc84e63b3fd2dfce37f08f8c18aeb81ef5cf6bb9b51f625cb4e6cd8"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-win_amd64.whl", hash = "sha256:fabbe18087c3d33c5824cb145ffca52eccd053061df1d79d4b66dafa5ad2a5ea"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:023af8c54fe63530545f70dd2a2a7eed18d07a9a77b94e8bf1e2ff7f252db9a3"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:d66624f04de4af8bbf1c7f21cc06649c1c69a7f84109179add573ce35e46d448"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c532d5ab79be0199fa2658e24a02fce8542df196e60665dd322409a03db6a52c"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e67ec74fada3841b8c5f4c4f197bea916025cb9aa3fe5abf7d52b655d042f956"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:30c653fde75a6e5eb814d2a0a89378f83d1d3f502ab710904ee585c38888816c"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:961eb86e5be7d0973789f30ebcf6caab60b844203f4396ece27310295a6082c7"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:598b65d74615c021423bd45c2bc5e9b59539c875a9bdb7e5f2a6b92dfcfc268d"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:599941da468f2cf22bf90a84f6e2a65524e87be2fce844f96f2dd9a6c9d1e635"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-win32.whl", hash = "sha256:e6f7f3f41faffaea6596da86ecc2389672fa949bd035251eab26dc6697451d05"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-win_amd64.whl", hash = "sha256:b8811d48078d1cf2a6863dafb896e68406c5f513048451cd2ded0473133473c7"}, + {file = "MarkupSafe-2.1.0.tar.gz", hash = "sha256:80beaf63ddfbc64a0452b841d8036ca0611e049650e20afcb882f5d3c266d65f"}, ] more-itertools = [ {file = "more-itertools-8.12.0.tar.gz", hash = "sha256:7dc6ad46f05f545f900dd59e8dfb4e84a4827b97b3cfecb175ea0c7d247f6064"}, diff --git a/site/source/_templates/layout.html b/site/source/_templates/layout.html index bb95615..7665808 100644 --- a/site/source/_templates/layout.html +++ b/site/source/_templates/layout.html @@ -5,8 +5,8 @@ {% block extrahead %} - + + content="Start9 sovereign computing with Embassy personal server."> {% endblock %} \ No newline at end of file diff --git a/site/source/about/index.rst b/site/source/about/index.rst index fafed3e..335c612 100644 --- a/site/source/about/index.rst +++ b/site/source/about/index.rst @@ -4,7 +4,7 @@ About ===== - Here you will find out how to join the community and give back! + Learn about Start9. .. raw:: html @@ -13,13 +13,13 @@ About
.. topic-box:: - :title: Start9 Labs + :title: Mission and Values :link: start9 :icon: scylla-icon scylla-icon--comparison :class: large-4 :anchor: View - Get acquainted with the Start9 principles. + Get acquainted with Start9. .. topic-box:: :title: Roadmap @@ -57,15 +57,6 @@ About See what open jobs we have available. -.. topic-box:: - :title: Contact Us - :link: contact - :icon: scylla-icon scylla-icon--contact-us - :class: large-4 - :anchor: Reach out - - Get in touch with any questions, concerns, or feedback. Your input is always welcome! - .. raw:: html
@@ -81,4 +72,3 @@ About license team jobs - contact diff --git a/site/source/conf.py b/site/source/conf.py index 352c4f7..04156d2 100644 --- a/site/source/conf.py +++ b/site/source/conf.py @@ -16,8 +16,8 @@ sys.path.insert(0, os.path.abspath('..')) # -- Project information ----------------------------------------------------- -project = 'Start9 Docs' -copyright = str(date.today().year) + ", Start9 Labs, Inc. All rights reserved." +project = 'Start9' +copyright = str(date.today().year) + ", Start9 Labs, Inc." author = u"Start9 Contributors" @@ -92,18 +92,18 @@ html_theme = "sphinx_scylladb_theme" html_theme_path = ["../../sphinx-scylladb-theme"] html_theme_options = { - "hide_sidebar_index": "true", - "conf_py_path": "docs/source/", + "conf_py_path": "site/source/", "banner_button_text": "Learn more", "banner_button_url": "https://docs.start9.com/latest", "banner_title_text": "EmbassyOS 0.3.0 is now released 🥳", + "hide_banner": "false", "hide_edit_this_page_button": "false", "hide_sidebar_index": "true", - "hide_banner": "false", "hide_version_dropdown": [], "github_issues_repository": "Start9Labs/documentation", "github_repository": "Start9Labs/documentation", - "site_description": "Start9 Product Documentation and Education Guides", + "navigation_depth": 3, + "site_description": "Start9 sovereign computing with Embassy personal server", } # Last updated format diff --git a/site/source/contribute/decentralize.rst b/site/source/contribute/decentralize.rst index 6218ee1..5994a8e 100644 --- a/site/source/contribute/decentralize.rst +++ b/site/source/contribute/decentralize.rst @@ -6,5 +6,5 @@ Decentralize EmbassyOS allows users to swap to an alternative Marketplace in case they want a service not offered in the official `Start9 Marketplace `_, would like a backup registry, or have for some reason lost trust in :ref:`Start9 `. -- In order to change to an unofficial Marketplace, you can see our documentaion :ref:`here `. +- In order to change to an unofficial Marketplace, you can see our documentaion :ref:`here `. - If you'd like to run your own Marketplace, and help decentralize the ecosystem, please see our guide `here `_. diff --git a/site/source/contribute/index.rst b/site/source/contribute/index.rst index 42e01c2..097d472 100644 --- a/site/source/contribute/index.rst +++ b/site/source/contribute/index.rst @@ -4,7 +4,7 @@ Contribute ========== - Here you will find out how to join the community and give back! + Join the community and get involved! .. raw:: html diff --git a/site/source/service-packaging/advanced/dev-tools/embassy-cli.rst b/site/source/developer-docs/advanced/dev-tools/embassy-cli.rst similarity index 100% rename from site/source/service-packaging/advanced/dev-tools/embassy-cli.rst rename to site/source/developer-docs/advanced/dev-tools/embassy-cli.rst diff --git a/site/source/service-packaging/advanced/dev-tools/embassy-sdk.rst b/site/source/developer-docs/advanced/dev-tools/embassy-sdk.rst similarity index 100% rename from site/source/service-packaging/advanced/dev-tools/embassy-sdk.rst rename to site/source/developer-docs/advanced/dev-tools/embassy-sdk.rst diff --git a/site/source/service-packaging/advanced/dev-tools/embassyd.rst b/site/source/developer-docs/advanced/dev-tools/embassyd.rst similarity index 100% rename from site/source/service-packaging/advanced/dev-tools/embassyd.rst rename to site/source/developer-docs/advanced/dev-tools/embassyd.rst diff --git a/site/source/service-packaging/advanced/dev-tools/index.rst b/site/source/developer-docs/advanced/dev-tools/index.rst similarity index 64% rename from site/source/service-packaging/advanced/dev-tools/index.rst rename to site/source/developer-docs/advanced/dev-tools/index.rst index 68ccdcd..87a3dfb 100644 --- a/site/source/service-packaging/advanced/dev-tools/index.rst +++ b/site/source/developer-docs/advanced/dev-tools/index.rst @@ -4,7 +4,7 @@ Developer Tools =============== -Brief overviews of Developer Tools that will come in handy when :ref:`packaging a service`, or interacting directly with the OS to learn or contribute to the project. +Brief overviews of Developer Tools that will come in handy when :ref:`packaging a service`, or interacting directly with the OS to learn or contribute to the project. .. toctree:: :maxdepth: 2 diff --git a/site/source/service-packaging/advanced/dev-tools/service-container.rst b/site/source/developer-docs/advanced/dev-tools/service-container.rst similarity index 93% rename from site/source/service-packaging/advanced/dev-tools/service-container.rst rename to site/source/developer-docs/advanced/dev-tools/service-container.rst index 03c856c..1c3566b 100644 --- a/site/source/service-packaging/advanced/dev-tools/service-container.rst +++ b/site/source/developer-docs/advanced/dev-tools/service-container.rst @@ -8,7 +8,7 @@ For simplicity, EmbassyOS is designed to be completely operated via the :ref:`We .. warning:: The following guide is for those that have advanced command line skills, or those who are being guided by a Start9 support technician. Nothing you do inside a container is supported unless under the direction of Start9. Here be dragons!! -This guide assumes you already have :ref:`SSH Access` setup on your machine. +This guide assumes you already have :ref:`SSH Access` setup on your machine. Open a terminal, ssh into your device, and enter the following command, replacing ```` with the name of the service you are trying to access. You can list the services with ``embassy-cli package list`` (you will need to be logged in under ``embassy-cli`` for this). You will need to either be ``root`` or use ``sudo``. diff --git a/site/source/service-packaging/advanced/index.rst b/site/source/developer-docs/advanced/index.rst similarity index 100% rename from site/source/service-packaging/advanced/index.rst rename to site/source/developer-docs/advanced/index.rst diff --git a/site/source/service-packaging/build-package-example/01_setup.rst b/site/source/developer-docs/build-package-example/01_setup.rst similarity index 100% rename from site/source/service-packaging/build-package-example/01_setup.rst rename to site/source/developer-docs/build-package-example/01_setup.rst diff --git a/site/source/service-packaging/build-package-example/02_create-service.rst b/site/source/developer-docs/build-package-example/02_create-service.rst similarity index 100% rename from site/source/service-packaging/build-package-example/02_create-service.rst rename to site/source/developer-docs/build-package-example/02_create-service.rst diff --git a/site/source/service-packaging/build-package-example/03_hardware-compile.rst b/site/source/developer-docs/build-package-example/03_hardware-compile.rst similarity index 100% rename from site/source/service-packaging/build-package-example/03_hardware-compile.rst rename to site/source/developer-docs/build-package-example/03_hardware-compile.rst diff --git a/site/source/service-packaging/build-package-example/04_docker-build.rst b/site/source/developer-docs/build-package-example/04_docker-build.rst similarity index 100% rename from site/source/service-packaging/build-package-example/04_docker-build.rst rename to site/source/developer-docs/build-package-example/04_docker-build.rst diff --git a/site/source/service-packaging/build-package-example/05_create-manifest.rst b/site/source/developer-docs/build-package-example/05_create-manifest.rst similarity index 100% rename from site/source/service-packaging/build-package-example/05_create-manifest.rst rename to site/source/developer-docs/build-package-example/05_create-manifest.rst diff --git a/site/source/service-packaging/build-package-example/06_create-assets.rst b/site/source/developer-docs/build-package-example/06_create-assets.rst similarity index 100% rename from site/source/service-packaging/build-package-example/06_create-assets.rst rename to site/source/developer-docs/build-package-example/06_create-assets.rst diff --git a/site/source/service-packaging/build-package-example/07_create-s9pk.rst b/site/source/developer-docs/build-package-example/07_create-s9pk.rst similarity index 100% rename from site/source/service-packaging/build-package-example/07_create-s9pk.rst rename to site/source/developer-docs/build-package-example/07_create-s9pk.rst diff --git a/site/source/service-packaging/build-package-example/08_create-makefile.rst b/site/source/developer-docs/build-package-example/08_create-makefile.rst similarity index 100% rename from site/source/service-packaging/build-package-example/08_create-makefile.rst rename to site/source/developer-docs/build-package-example/08_create-makefile.rst diff --git a/site/source/service-packaging/build-package-example/09_create-wrapper.rst b/site/source/developer-docs/build-package-example/09_create-wrapper.rst similarity index 100% rename from site/source/service-packaging/build-package-example/09_create-wrapper.rst rename to site/source/developer-docs/build-package-example/09_create-wrapper.rst diff --git a/site/source/service-packaging/build-package-example/10_install-package.rst b/site/source/developer-docs/build-package-example/10_install-package.rst similarity index 91% rename from site/source/service-packaging/build-package-example/10_install-package.rst rename to site/source/developer-docs/build-package-example/10_install-package.rst index 71cd527..a02380f 100644 --- a/site/source/service-packaging/build-package-example/10_install-package.rst +++ b/site/source/developer-docs/build-package-example/10_install-package.rst @@ -4,7 +4,7 @@ Step 10 - Install ================= -Now that we have a process for iterating on producing a valid package for EmbassyOS, let's try to load it onto an Embassy device! If you do not have one, you can either :ref:`purchase ` a device or build one using our :ref:`DIY guide `. +Now that we have a process for iterating on producing a valid package for EmbassyOS, let's load it onto an Embassy! 1. First, generate an ssh key for the Embassy: diff --git a/site/source/service-packaging/build-package-example/index.rst b/site/source/developer-docs/build-package-example/index.rst similarity index 100% rename from site/source/service-packaging/build-package-example/index.rst rename to site/source/developer-docs/build-package-example/index.rst diff --git a/site/source/service-packaging/build-package-example/resources.rst b/site/source/developer-docs/build-package-example/resources.rst similarity index 100% rename from site/source/service-packaging/build-package-example/resources.rst rename to site/source/developer-docs/build-package-example/resources.rst diff --git a/site/source/service-packaging/getting-started/environment-setup.rst b/site/source/developer-docs/getting-started/environment-setup.rst similarity index 97% rename from site/source/service-packaging/getting-started/environment-setup.rst rename to site/source/developer-docs/getting-started/environment-setup.rst index 343de42..2b4b9b9 100644 --- a/site/source/service-packaging/getting-started/environment-setup.rst +++ b/site/source/developer-docs/getting-started/environment-setup.rst @@ -84,8 +84,6 @@ EmbassyOS While not strictly necessary, having a running instance of EmbassyOS is recommended to test installing, running, configuring, and using your package. Without this component, you will have to coordinate with Start9's internal development team to test. -You can acquire EmbassyOS by :ref:`purchasing ` or following the :ref:`DIY guide `. - .. _environment-quick-start: Quick Start Environment Setup diff --git a/site/source/service-packaging/getting-started/index.rst b/site/source/developer-docs/getting-started/index.rst similarity index 100% rename from site/source/service-packaging/getting-started/index.rst rename to site/source/developer-docs/getting-started/index.rst diff --git a/site/source/service-packaging/getting-started/quick-start.rst b/site/source/developer-docs/getting-started/quick-start.rst similarity index 100% rename from site/source/service-packaging/getting-started/quick-start.rst rename to site/source/developer-docs/getting-started/quick-start.rst diff --git a/site/source/service-packaging/getting-started/sdk.rst b/site/source/developer-docs/getting-started/sdk.rst similarity index 100% rename from site/source/service-packaging/getting-started/sdk.rst rename to site/source/developer-docs/getting-started/sdk.rst diff --git a/site/source/service-packaging/index.rst b/site/source/developer-docs/index.rst similarity index 94% rename from site/source/service-packaging/index.rst rename to site/source/developer-docs/index.rst index 8853018..2b514ca 100644 --- a/site/source/service-packaging/index.rst +++ b/site/source/developer-docs/index.rst @@ -1,10 +1,10 @@ -.. _service-packaging: +.. _developer-docs: -========================== -Service Packaging Overview -========================== +============== +Developer Docs +============== - Welcome to Service Packaging! + Welcome to Service Packaging for EmbassyOS! If you are here, you are interested in becoming part of the mission to change the future of personal computing. diff --git a/site/source/service-packaging/specification/backups.rst b/site/source/developer-docs/specification/backups.rst similarity index 100% rename from site/source/service-packaging/specification/backups.rst rename to site/source/developer-docs/specification/backups.rst diff --git a/site/source/service-packaging/specification/compat/index.rst b/site/source/developer-docs/specification/compat/index.rst similarity index 100% rename from site/source/service-packaging/specification/compat/index.rst rename to site/source/developer-docs/specification/compat/index.rst diff --git a/site/source/service-packaging/specification/compat/rules.rst b/site/source/developer-docs/specification/compat/rules.rst similarity index 100% rename from site/source/service-packaging/specification/compat/rules.rst rename to site/source/developer-docs/specification/compat/rules.rst diff --git a/site/source/service-packaging/specification/config-spec.rst b/site/source/developer-docs/specification/config-spec.rst similarity index 100% rename from site/source/service-packaging/specification/config-spec.rst rename to site/source/developer-docs/specification/config-spec.rst diff --git a/site/source/service-packaging/specification/dependencies.rst b/site/source/developer-docs/specification/dependencies.rst similarity index 100% rename from site/source/service-packaging/specification/dependencies.rst rename to site/source/developer-docs/specification/dependencies.rst diff --git a/site/source/service-packaging/specification/docker.rst b/site/source/developer-docs/specification/docker.rst similarity index 100% rename from site/source/service-packaging/specification/docker.rst rename to site/source/developer-docs/specification/docker.rst diff --git a/site/source/service-packaging/specification/index.rst b/site/source/developer-docs/specification/index.rst similarity index 100% rename from site/source/service-packaging/specification/index.rst rename to site/source/developer-docs/specification/index.rst diff --git a/site/source/service-packaging/specification/instructions.rst b/site/source/developer-docs/specification/instructions.rst similarity index 100% rename from site/source/service-packaging/specification/instructions.rst rename to site/source/developer-docs/specification/instructions.rst diff --git a/site/source/service-packaging/specification/makefile.rst b/site/source/developer-docs/specification/makefile.rst similarity index 100% rename from site/source/service-packaging/specification/makefile.rst rename to site/source/developer-docs/specification/makefile.rst diff --git a/site/source/service-packaging/specification/manifest.rst b/site/source/developer-docs/specification/manifest.rst similarity index 100% rename from site/source/service-packaging/specification/manifest.rst rename to site/source/developer-docs/specification/manifest.rst diff --git a/site/source/service-packaging/specification/package.rst b/site/source/developer-docs/specification/package.rst similarity index 100% rename from site/source/service-packaging/specification/package.rst rename to site/source/developer-docs/specification/package.rst diff --git a/site/source/service-packaging/specification/properties.rst b/site/source/developer-docs/specification/properties.rst similarity index 100% rename from site/source/service-packaging/specification/properties.rst rename to site/source/developer-docs/specification/properties.rst diff --git a/site/source/service-packaging/specification/submission.rst b/site/source/developer-docs/specification/submission.rst similarity index 100% rename from site/source/service-packaging/specification/submission.rst rename to site/source/developer-docs/specification/submission.rst diff --git a/site/source/service-packaging/specification/wrapper.rst b/site/source/developer-docs/specification/wrapper.rst similarity index 100% rename from site/source/service-packaging/specification/wrapper.rst rename to site/source/developer-docs/specification/wrapper.rst diff --git a/site/source/index.rst b/site/source/index.rst index 107fbf1..e6b2dcb 100644 --- a/site/source/index.rst +++ b/site/source/index.rst @@ -1,19 +1,20 @@ -.. title:: Start9 Documentation +.. title:: Sovereign Computing .. raw:: html
.. hero-box:: - :title: Become unstoppable - :button_icon: scylla-icon scylla-icon--monitoring + :title: Welcome + :button_url: https://store.start9.com + :button_text: Purchase Embassy :image: /_static/img/eos_0.3.0.png - Here you will find guidance and information about the Start9 Embassy personal server and its operating system, EmbassyOS. + Here you will find information about Start9, EmbassyOS, and the era of sovereign computing. .. raw:: html -
+
.. raw:: html @@ -22,22 +23,22 @@
.. topic-box:: - :title: Purchasing - :link: https://store.start9.com + :title: Purchase + :link: https://store.start9.com :icon: scylla-icon scylla-icon--bitcoin :class: large-4 :anchor: Buy now - Learn about how you can purchase Start9 products + Buy an Embassy from Start9. .. topic-box:: - :title: Build your own - :link: support/user-manual/tuning/diy + :title: DIY + :link: user-manual/misc-guides/diy :icon: scylla-icon scylla-icon--integrations :class: large-4 :anchor: Get started - Build from source with our DIY guide + Build your own Embassy. .. topic-box:: :title: Service Marketplace @@ -50,7 +51,7 @@ .. topic-box:: :title: User Manual - :link: support/user-manual + :link: user-manual :icon: scylla-icon scylla-icon--knowledge-base :class: large-6 :anchor: View @@ -76,8 +77,8 @@ Read our FAQ and learn about platform concepts .. topic-box:: - :title: SDK - :link: service-packaging + :title: Developer Docs + :link: developer-docs :icon: scylla-icon scylla-icon--open-source :class: large-3 :anchor: View @@ -112,14 +113,15 @@ .. This is for the side navigation display .. toctree:: - :maxdepth: 2 + :maxdepth: 3 :hidden: + user-manual/index support/index learn/index contribute/index about/index - service-packaging/index + developer-docs/index .. raw:: html diff --git a/site/source/learn/concepts/open-source.rst b/site/source/learn/concepts/open-source.rst index c2d39b8..047de81 100644 --- a/site/source/learn/concepts/open-source.rst +++ b/site/source/learn/concepts/open-source.rst @@ -23,6 +23,6 @@ Some software has dependencies on other software. Software may even require its Traditionally, managing dependencies was a massive headache and a huge barrier to running a personal server. But no more! The Embassy's revolutionary dependency management system makes the process transparent and simple. -If a :ref:`service` has one or more dependencies, or a dependency needs to be configured in a particular way, your Embassy will inform you and offer solutions. +If a service has one or more dependencies, or a dependency needs to be configured in a particular way, your Embassy will inform you and offer solutions. Sometimes, a dependency can be satisfied in multiple ways. For example, Lightning has a dependency on Bitcoin. But that does not necessarily mean you need to have Bitcoin installed on your Embassy. You could just as easily configure Lightning to use another Bitcoin node located somewhere else! diff --git a/site/source/about/contact.rst b/site/source/support/contact.rst similarity index 100% rename from site/source/about/contact.rst rename to site/source/support/contact.rst diff --git a/site/source/support/faq/faq-basic-use.rst b/site/source/support/faq/faq-basic-use.rst index 8dded4d..b43c575 100644 --- a/site/source/support/faq/faq-basic-use.rst +++ b/site/source/support/faq/faq-basic-use.rst @@ -23,7 +23,7 @@ Check out the `docs ` for some details on your Embassy. You can now access your Embassy and find the Services you want from the "Marketplace" tab, then clicking "Install." The Service will let you know if you need any "dependencies," or pre-requisite Services, first. After you have a Service installed, don't forget to "Start" the service. Check out :ref:`Services` for more info. +Check out the :ref:`Dashboard Overview` for some details on your Embassy. You can now access your Embassy and find the Services you want from the "Marketplace" tab, then clicking "Install." The Service will let you know if you need any "dependencies," or pre-requisite Services, first. After you have a Service installed, don't forget to "Start" the service. Can I move my Embassy to another location? What happens when I do this? ------------------------------------------------------------------------ diff --git a/site/source/support/faq/faq-general.rst b/site/source/support/faq/faq-general.rst index f3f7efe..bfc658e 100644 --- a/site/source/support/faq/faq-general.rst +++ b/site/source/support/faq/faq-general.rst @@ -69,7 +69,7 @@ The .s9pk extension is Start9's custom package format based on tar. It encompass What are EmbassyOS Services? ---------------------------- -A Service can be any piece of software added to the Marketplace. All services are "self-hosted," meaning that you are in complete control of your data. This means you can run your own "cloud!" Learn more about managing services :ref:`here ` and see our currently :ref:`Available Services `. +A Service can be any piece of software added to the Marketplace. All services are "self-hosted," meaning that you are in complete control of your data. This means you can run your own "cloud!" Learn more about managing services :ref:`here ` and see our currently `Available Services `_. Does the Embassy ship worldwide? -------------------------------- diff --git a/site/source/support/faq/faq-services.rst b/site/source/support/faq/faq-services.rst index d81af4e..ef0105f 100644 --- a/site/source/support/faq/faq-services.rst +++ b/site/source/support/faq/faq-services.rst @@ -33,7 +33,7 @@ To get a general idea of what is required of an app, answer these questions: If all answers are yes, then it can run on EmbassyOS. -Packing up a service for the Embassy does not require extensive development skills. If you are interested in doing do, please see our :ref:`Service Packaging Overview `. +Packing up a service for the Embassy does not require extensive development skills. If you are interested in doing do, please see our :ref:`Developer Docs `. We are aggressively moving away from service development in favor of a more community driven approach. Meaning you, an app development team, or anyone else on Earth, can bring the Service they want to an Embassy Marketplace. You don't need our permission. diff --git a/site/source/support/index.rst b/site/source/support/index.rst index 8d0df2b..1dc0a95 100644 --- a/site/source/support/index.rst +++ b/site/source/support/index.rst @@ -4,7 +4,7 @@ Support ======= - Here you will find help on how to use your devices, answers to frequently asked questions, and documentation for developers. + View frequently asked questions, troubleshoot common issues, or contact support. .. raw:: html @@ -12,41 +12,32 @@ Support
-.. topic-box:: - :title: User Manual - :link: user-manual - :icon: scylla-icon scylla-icon--docs - :class: large-4 - :anchor: View - - All you need to be the owner/operator of your own self-hosted software - .. topic-box:: :title: FAQ :link: faq :icon: scylla-icon scylla-icon--monitoring - :class: large-4 - :anchor: Get Answers + :class: large-5 + :anchor: View Answers to Frequently Asked Questions from Embassy users .. topic-box:: - :title: Service Packaging - :link: ../service-packaging - :icon: scylla-icon scylla-icon--open-source - :class: large-4 - :anchor: Build + :title: Troubleshooting + :link: troubleshooting + :icon: scylla-icon scylla-icon--monitoring + :class: large-5 + :anchor: View - Tools and guides for service packagers + Explore common problems and their solutions .. topic-box:: - :title: Community Channels - :link: ../about/contact + :title: Contact + :link: contact :icon: scylla-icon scylla-icon--networking - :class: large-4 - :anchor: Join us + :class: large-5 + :anchor: Get help - Network with the community to get help and offer your skills and insights to the cause! + Get help from Start9 and the community directly .. raw:: html @@ -57,5 +48,6 @@ Support :maxdepth: 1 :hidden: - user-manual/index - faq/index \ No newline at end of file + faq/index + troubleshooting/index + contact diff --git a/site/source/support/user-manual/troubleshooting/index.rst b/site/source/support/troubleshooting/index.rst similarity index 100% rename from site/source/support/user-manual/troubleshooting/index.rst rename to site/source/support/troubleshooting/index.rst diff --git a/site/source/support/user-manual/troubleshooting/shoot-connection.rst b/site/source/support/troubleshooting/shoot-connection.rst similarity index 100% rename from site/source/support/user-manual/troubleshooting/shoot-connection.rst rename to site/source/support/troubleshooting/shoot-connection.rst diff --git a/site/source/support/user-manual/troubleshooting/shoot-embassy.rst b/site/source/support/troubleshooting/shoot-embassy.rst similarity index 74% rename from site/source/support/user-manual/troubleshooting/shoot-embassy.rst rename to site/source/support/troubleshooting/shoot-embassy.rst index d42b613..b5b0a76 100644 --- a/site/source/support/user-manual/troubleshooting/shoot-embassy.rst +++ b/site/source/support/troubleshooting/shoot-embassy.rst @@ -26,4 +26,4 @@ Software I'm having an issue with a particular Service ============================================= -If a Service is crashing or acting up in some way, check the `Documentation` and `FAQ` for that particular Service. You can also check the `Logs` of a service, which might tell you what the problem is. If that is not helpful, try to restart the service to see if that clears up the issue. If you are still having issues, please reach out in one of our `Community Channels` for immediate assistance, or email support@start9labs.com for help during business hours. +If a Service is crashing or acting up in some way, check the `Documentation` and `FAQ` for that particular Service. You can also check the `Logs` of a service, which might tell you what the problem is. If that is not helpful, try to restart the service to see if that clears up the issue. If you are still having issues, please reach out in one of our `Community Channels` for immediate assistance, or email support@start9labs.com for help during business hours. diff --git a/site/source/support/user-manual/configuration/backup-setup/backup-mac.rst b/site/source/support/user-manual/configuration/backup-setup/backup-mac.rst deleted file mode 100644 index e8da408..0000000 --- a/site/source/support/user-manual/configuration/backup-setup/backup-mac.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _backup-mac: - -=== -Mac -=== - -There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop or desktop, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy. - -Remote Backups --------------- - -#. Go to system settings -#. Click sharing -#. Click file sharing -#. Click the + under shared folders -#. Add a folder -#. Click options -#. Enable Windows file sharing for the user you would like to use to authenticate -#. Click done -#. Enter the name of your macbook, as shown in the computer name field at the top of the sharing page into the hostname field in embassy ui -#. Enter the name of the folder as shown in the shared folders section as the path -#. Enter your macbook username and password for the user that you enabled windows file sharing for - -Local Backups -------------- - -#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered. -#. Plug in power to your hub or drive -#. Boot Embassy and go to ``Embassy`` -> ``Create Backup`` - diff --git a/site/source/support/user-manual/configuration/backup-setup/backup-win.rst b/site/source/support/user-manual/configuration/backup-setup/backup-win.rst deleted file mode 100644 index 0b51940..0000000 --- a/site/source/support/user-manual/configuration/backup-setup/backup-win.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _backups-win: - -======= -Windows -======= - -There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop or desktop, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy. - -Remote Backups --------------- - -#. Create a folder -#. Right click the folder -#. Select "properties" -#. Click the share tab -#. Click share... -#. Select a user you want to use for login, or select everyone -#. Click share -#. Enter your computer name into the hostname field in embassy ui (the name is shown after a \\ in the windows ui) -#. Enter the path that is shown after the hostname in the windows ui into the path field -#. Enter your username for the windows computer -#. Enter the password for the windows computer - -Local Backups -------------- - -#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered. -#. Plug in power to your hub or drive -#. Boot Embassy and go to ``Embassy`` -> ``Create Backup`` - diff --git a/site/source/support/user-manual/configuration/backup-setup/index.rst b/site/source/support/user-manual/configuration/backup-setup/index.rst deleted file mode 100644 index fd45126..0000000 --- a/site/source/support/user-manual/configuration/backup-setup/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _backup-setup: - -======= -Backups -======= - -In addition to safekeeping of a good master password, maintaining good backups are among the few major responsibilities required to keep the benefits and freedom that come with self-hosting. - -.. toctree:: - :maxdepth: 2 - - backup-lin - backup-mac - backup-win diff --git a/site/source/support/user-manual/configuration/basic-config.rst b/site/source/support/user-manual/configuration/basic-config.rst deleted file mode 100644 index 56d7c67..0000000 --- a/site/source/support/user-manual/configuration/basic-config.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. _basic-config: - -=================== -Basic Configuration -=================== - -.. .. _auto-reporting: - -.. Automatically Report Bugs -.. ------------------------- - -.. You are asked at first setup if you would like to provide bug reports to Start9. You can edit that setting here if you change your mind. This data is anonymous and you can see exactly what is collected :ref:`here`. - -.. #. As in the :ref:`Set Device Name` steps above, go to the ``Embasssy`` tab, then under ``Settings``, click ``Preferences`` - -.. #. Click ``Auto Report Bugs`` and either ``Enable`` or ``Disable`` - -.. .. figure:: /_static/images/config/basic-config3.png -.. :width: 60% -.. :alt: Automatically Report Bugs - -.. _auto-update: - -Automatically Check for Updates -------------------------------- - -Automatic check for updates enables you to choose whether you want to be informed of EmbassyOS updates. Enabling this feature makes a request to the Start9 Marketplace to see if a new OS version has been released, and notifies you if so. This request is only made when you log into a new session or refresh your current session. - -#. Go to the ``Embasssy`` tab, then under ``Settings``, click ``Preferences`` - -#. Click ``Automatically Check for Updates`` and either ``Enable`` or ``Disable`` - - .. figure:: /_static/images/config/basic-config4.png - :width: 60% - :alt: Automatically Report Bugs diff --git a/site/source/support/user-manual/configuration/index.rst b/site/source/support/user-manual/configuration/index.rst deleted file mode 100644 index 42453b5..0000000 --- a/site/source/support/user-manual/configuration/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _config: - -============= -Configuration -============= - -Configuration, setup guides, and known limitations are provided here by device. - -.. toctree:: - :maxdepth: 2 - - basic-config - backup-setup/index - tor-setup/index - lan-setup/index - wifi - limitations/index diff --git a/site/source/support/user-manual/getting-started/device-guides/dg-android.rst b/site/source/support/user-manual/getting-started/device-guides/dg-android.rst deleted file mode 100644 index 233cf3a..0000000 --- a/site/source/support/user-manual/getting-started/device-guides/dg-android.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _dg-android: - -======= -Android -======= - -.. tip:: Please see Android's :ref:`Known Limitations` to understand what is currently not possible on these devices - - -.. topic-box:: - :title: LAN Setup (Connectivity, Performance) - :link: https://start9.com/latest/support/user-manual/configuration/lan-setup/lan-android - :anchor: Setup - - For a fast and secure connection while on your Embassy's local network - -.. topic-box:: - :title: Tor Setup (Connectivity) - :link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-os/tor-android - :anchor: Setup - - Run Tor natively (in the background) on your device. This will allow you to use applications on your Windows machine via the Tor Network so they can communicate with your Embassy. - -.. topic-box:: - :title: Tor Firefox Config (Connectivity) - :link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-firefox/torff-android - :anchor: Configure - - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers. diff --git a/site/source/support/user-manual/getting-started/device-guides/dg-ios.rst b/site/source/support/user-manual/getting-started/device-guides/dg-ios.rst deleted file mode 100644 index 91053c1..0000000 --- a/site/source/support/user-manual/getting-started/device-guides/dg-ios.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _dg-ios: - -=== -iOS -=== - -.. tip:: Please see iOS's :ref:`Known Limitations` to understand what is currently not possible on these devices - -.. topic-box:: - :title: LAN Setup (Connectivity, Performance) - :link: https://start9.com/latest/support/user-manual/configuration/lan-setup/lan-ios - :anchor: Setup - - For a fast and secure connection while on your Embassy's local network diff --git a/site/source/support/user-manual/getting-started/device-guides/dg-linux.rst b/site/source/support/user-manual/getting-started/device-guides/dg-linux.rst deleted file mode 100644 index 5f89d68..0000000 --- a/site/source/support/user-manual/getting-started/device-guides/dg-linux.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. _dg-linux: - -===== -Linux -===== - -.. tip:: Please see Linux's :ref:`Known Limitations` to understand what is currently not possible on these devices - -.. topic-box:: - :title: LAN Setup (Connectivity, Performance) - :link: https://start9.com/latest/support/user-manual/configuration/lan-setup/lan-linux - :anchor: Setup - - For a fast and secure connection while on your Embassy's local network - -.. topic-box:: - :title: Tor Setup (Connectivity) - :link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-os/tor-linux - :anchor: Setup - - Run Tor natively (in the background) on your device. This will allow you to use applications on your Windows machine via the Tor Network so they can communicate with your Embassy. - -.. topic-box:: - :title: Tor Firefox Config (Connectivity) - :link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-firefox/torff-linux - :anchor: Configure - - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers. - -.. topic-box:: - :title: Embassy Backups (Resilience) - :link: https://start9.com/latest/support/user-manual/walkthrough/backup/backup-lin - :anchor: Backup - - Configure remote backups of your Embassy to your Windows machine. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster. diff --git a/site/source/support/user-manual/getting-started/device-guides/dg-mac.rst b/site/source/support/user-manual/getting-started/device-guides/dg-mac.rst deleted file mode 100644 index ce53647..0000000 --- a/site/source/support/user-manual/getting-started/device-guides/dg-mac.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. _dg-mac: - -=== -Mac -=== - -.. tip:: Please see Mac's :ref:`Known Limitations` to understand what is currently not possible on these devices - -.. topic-box:: - :title: LAN Setup (Connectivity, Performance) - :link: https://start9.com/latest/support/user-manual/configuration/lan-setup/lan-mac - :anchor: Setup - - For a fast and secure connection while on your Embassy's local network - -.. topic-box:: - :title: Tor Setup (Connectivity) - :link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-os/tor-mac - :anchor: Setup - - Run Tor natively (in the background) on your device. This will allow you to use applications on your Windows machine via the Tor Network so they can communicate with your Embassy. - -.. topic-box:: - :title: Tor Firefox Config (Connectivity) - :link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-firefox/torff-mac - :anchor: Configure - - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers. - -.. topic-box:: - :title: Embassy Backups (Resilience) - :link: https://start9.com/latest/support/user-manual/walkthrough/backup/backup-mac - :anchor: Backup - - Configure remote backups of your Embassy to your Windows machine. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster. diff --git a/site/source/support/user-manual/getting-started/device-guides/dg-windows.rst b/site/source/support/user-manual/getting-started/device-guides/dg-windows.rst deleted file mode 100644 index bd8e9a4..0000000 --- a/site/source/support/user-manual/getting-started/device-guides/dg-windows.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. _dg-windows: - -======= -Windows -======= - -.. tip:: Please see Window's :ref:`Known Limitations` to understand what is currently not possible on these devices. - -.. topic-box:: - :title: LAN Setup (Connectivity, Performance) - :link: https://start9.com/latest/support/user-manual/configuration/lan-setup/lan-windows - :anchor: Setup - - For a fast and secure connection while on your Embassy's local network - -.. topic-box:: - :title: Tor Setup (Connectivity) - :link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-os/tor-windows - :anchor: Setup - - Run Tor natively (in the background) on your device. This will allow you to use applications on your Windows machine via the Tor Network so they can communicate with your Embassy. - -.. topic-box:: - :title: Tor Firefox Config (Connectivity) - :link: https://start9.com/latest/support/user-manual/configuration/tor-setup/tor-firefox/torff-windows - :anchor: Configure - - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers. - -.. topic-box:: - :title: Embassy Backups (Resilience) - :link: https://start9.com/latest/support/user-manual/walkthrough/backup/backup-win - :anchor: Backup - - Configure remote backups of your Embassy to your Windows machine. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster. diff --git a/site/source/support/user-manual/getting-started/index.rst b/site/source/support/user-manual/getting-started/index.rst deleted file mode 100644 index d2b12d1..0000000 --- a/site/source/support/user-manual/getting-started/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _getting-started: - -=============== -Getting Started -=============== - -Take your first steps! If you are setting up your device for the first time, you can also skip straight to :ref:`Initial Setup `. - -.. toctree:: - :maxdepth: 2 - - introduction - purchasing - initial-setup - recover-02 - recover-03 - device-guides/index diff --git a/site/source/support/user-manual/getting-started/introduction.rst b/site/source/support/user-manual/getting-started/introduction.rst deleted file mode 100644 index fd9369c..0000000 --- a/site/source/support/user-manual/getting-started/introduction.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _introduction: - -============ -Introduction -============ - -:ref:`Embassy` is a new kind of personal computer - one that sits quietly on your shelf and runs all day and night. It has no screen and no keyboard. You access your Embassy from anywhere in the world in total, trustless privacy, simply by visiting its unique Tor address (.onion URL) right from the browser. - -Embassy is composed of commonly available hardware components that can be sourced and assembled by anyone, anywhere, for a marginal fee. Embassy is powered by :ref:`EmbassyOS`, the open-source operating system by :ref:`Start9`. - -So, what do you do with your Embassy? You use it to run services: Bitcoin, Lightning, personal cloud storage, P2P messaging, password management, etc. The list of available services is growing quickly and will eventually encompass the entirety of open-source, self-hosted software. - -Every communication between you and your Embassy is end-to-end encrypted and onion routed over the :ref:`Tor network`. All services are open-source and self-hosted, meaning there are no trusted third parties of any kind. - -To get an Embassy, you can :ref:`purchase` one directly from Start9, or you can :ref:`build one yourself`. diff --git a/site/source/support/user-manual/getting-started/purchasing.rst b/site/source/support/user-manual/getting-started/purchasing.rst deleted file mode 100644 index 574e110..0000000 --- a/site/source/support/user-manual/getting-started/purchasing.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _purchasing: - -========== -Purchasing -========== - -For maximum convenience, you can purchase an Embassy device, or EmbassyOS, directly from Start9 through our `Shopify Store `_. The device comes in a beautiful box, fully-assembled, and pre-installed with the latest version of :ref:`EmbassyOS`. We do our own hardware assembly and fulfillment, and we only collect the minimal information necessary to fulfill your order. And yes, we accept Bitcoin, as well as Lightning payments. - -If you prefer to build your own Embassy, you can follow the :ref:`DIY Guide `. diff --git a/site/source/support/user-manual/getting-started/recover-03.rst b/site/source/support/user-manual/getting-started/recover-03.rst deleted file mode 100644 index 0486019..0000000 --- a/site/source/support/user-manual/getting-started/recover-03.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _recover-03x: - -=================== -Recover v0.3.x Data -=================== - -Recover Embassy Series 0.3.x Data ---------------------------------- - -This guide will cover how to recover existing EmbassyOS version 0.3.x data. - -Recover From Remote Backup -========================== - - -Recover From Local (External Drive) Backup -========================================== diff --git a/site/source/support/user-manual/index.rst b/site/source/support/user-manual/index.rst deleted file mode 100644 index 4eeca1d..0000000 --- a/site/source/support/user-manual/index.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. _user-manual: - -=========== -User Manual -=========== - -.. toctree:: - :maxdepth: 1 - :hidden: - - getting-started/index - walkthrough/index - configuration/index - tuning/index - services/index - troubleshooting/index - -.. panel-box:: - :title: Overview - :id: "getting-started" - :class: my-panel - - EmbassyOS is designed to work out of the box with a minimal setup and immediate practicality. That said, there are many use-cases and utilities that can be added and tweaked at your convenience, which are covered extensively in this manual. You can get started right away with :ref:`Initial Setup `, head to our :doc:`Walkthrough ` for a guided tour, or learn about :doc:`Services ` and how to use them. In the :doc:`Configuration ` and :doc:`Tuning ` chapters, you can put your Embassy to work, and make it unique. Finally, you can cure common issues with :doc:`Troubleshooting ` or find answers in our :ref:`FAQ`. - - For further information, check out our :ref:`Knowledge Base ` to learn about the technologies behind Embassy. If you want to build your own Embassy, check out the :ref:`DIY Guide`. When you're ready to build, please check out our :ref:`Service Packaging Overview `. Please don't hestitate to :ref:`Contact Us ` if you have any issues, questions, or suggestions. - - * :doc:`Getting Started ` - Initial setup and device-specific guides to connect with your Embassy. - * :doc:`Walkthrough ` - A guided tour of EmbassyOS. - * :doc:`Services ` - Overview of featured Services and general usage on EmbassyOS. - * :doc:`Configuration ` - Configure your Embassy to your preference. - * :doc:`Tuning ` - Customize your Embassy with advanced configuration and external service integrations. - * :doc:`Troubleshooting ` - Resolve any common issues you may encounter. diff --git a/site/source/support/user-manual/services/index.rst b/site/source/support/user-manual/services/index.rst deleted file mode 100644 index 355ff63..0000000 --- a/site/source/support/user-manual/services/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _services: - -======== -Services -======== - -An overview of Services and Marketplaces on EmbassyOS. - -.. toctree:: - :maxdepth: 2 - - marketplace - managing-services/index diff --git a/site/source/support/user-manual/services/managing-services/service-donate.rst b/site/source/support/user-manual/services/managing-services/service-donate.rst deleted file mode 100644 index 705849a..0000000 --- a/site/source/support/user-manual/services/managing-services/service-donate.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _service-donate: - -====== -Donate -====== - -Currently, this is a link provided by the service package developer so that you may donate to them or the developer of the service they packaged directly. If this is not provided, a pop-up message will let you know this, and you will need to find the devs on their own platforms in order to donate. - - .. figure:: /_static/images/services/donate.png - :width: 60% - -.. topic-box:: - :title: Looking Forward - - We intend to leverage the power of Embassy's Lightning Network options to create the choice for a user to immediately send sats to a developer. Ideally, this will have a percentage breakdown for the service developer, service packager, and Start9, for the user to delegate their donation as they choose. We are serious about helping to incentivize :ref:`Open Source` development. diff --git a/site/source/support/user-manual/services/managing-services/service-overview.rst b/site/source/support/user-manual/services/managing-services/service-overview.rst deleted file mode 100644 index f0299cb..0000000 --- a/site/source/support/user-manual/services/managing-services/service-overview.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. _service-overview: - -======== -Overview -======== - -Services are very similar to Applications on a mobile device. The biggest differences are that they are often designed to run constantly, with 24/7 availability for when a user requires them. This is why they are called :ref:`Services`, they are always ready to serve users! - -.. _service-page: - -The Service Page ----------------- - -.. figure:: /_static/images/services/service8.png - :width: 60% - - The Service Page - -In the image above, we see an example of a Service's homescreen, where you can access all the information and utilities of a particular service. - -Below, we highlight the quick, need-to-know information of a Service that a user will want to see right away. - -.. figure:: /_static/images/services/service00.png - :width: 60% - -.. _service-status: - -We can see the Service (Embassy Pages in this case), its ``Status``, ``Health Checks`` (if it has any), ``Dependencies`` (if it has any), and the ability to ``Start`` or ``Stop`` the Service, as well as ``Launch UI`` if it has a :ref:`Web Interface `. Here's a breakdown of what each of these means: - - - Status: - - Needs Config: The Service needs your attention in making a configuration decision. There will always be default options available to you. - - Stopping... : Service is being stopped - - Stopped: Service is installed and configured, but not currently running. - - Starting... : Service is booting up - - Running: Service is running - - Health Checks: This is a critical feature of EmbassyOS. Health Checks are configured by the service packager in order to quickly convey to the user what is happening with their service, and possible actions they may want to take. Learn more about :ref:`Health Checks `. - - Dependencies: A service may require another service, called a dependency, in order to work. These may be optional, or required. Learn more about :ref:`Dependencies `. - - Start / Stop: Self-explanatory, use these buttons to start or stop a service. - - Launch UI: If available, this will open the User Interface (UI) for the service in a new browser tab. Learn more about :ref:`Web UIs`. diff --git a/site/source/support/user-manual/services/marketplace.rst b/site/source/support/user-manual/services/marketplace.rst deleted file mode 100644 index c42fb0e..0000000 --- a/site/source/support/user-manual/services/marketplace.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _service-marketplace: - -=========== -Marketplace -=========== - -Embassy Marketplace -------------------- - -We now have a fully interactive, live `Marketplace `_!! Visit now to see currently available services and get a feel for the ecosystem! - -Community Wishlist ------------------- - -You can visit the `Embassy: Voice `_ unofficial feedback forum to see what the Community are asking for and make your own suggestions! - -You can also make suggestions on our `Github Discussions `_ forum. diff --git a/site/source/support/user-manual/tuning/advanced-config/index.rst b/site/source/support/user-manual/tuning/advanced-config/index.rst deleted file mode 100644 index e16b6a8..0000000 --- a/site/source/support/user-manual/tuning/advanced-config/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _advanced-config: - -=============== -Advanced Config -=============== - -Custom options for folks that "know what they're doing." - -.. toctree:: - :maxdepth: 2 - - ssh-setup - ssh-tor - alt-marketplace diff --git a/site/source/support/user-manual/tuning/index.rst b/site/source/support/user-manual/tuning/index.rst deleted file mode 100644 index 292f470..0000000 --- a/site/source/support/user-manual/tuning/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _tuning: - -====== -Tuning -====== - -Here, you can customize your Embassy with advanced configuration, setup external tools, migrate from old projects, or build your own Embassy from scratch. - -.. toctree:: - :maxdepth: 2 - - diy - advanced-config/index - tune-embassy-os - service-guides/index diff --git a/site/source/support/user-manual/walkthrough/index.rst b/site/source/support/user-manual/walkthrough/index.rst deleted file mode 100644 index ca410cd..0000000 --- a/site/source/support/user-manual/walkthrough/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _walkthrough: - -=========== -Walkthrough -=========== - -An overview of EmbassyOS general capabilities. - -.. toctree:: - :maxdepth: 2 - - overview - updates - backups - password - sessions - - diff --git a/site/source/support/user-manual/tuning/advanced-config/alt-marketplace.rst b/site/source/user-manual/alt-marketplaces.rst similarity index 91% rename from site/source/support/user-manual/tuning/advanced-config/alt-marketplace.rst rename to site/source/user-manual/alt-marketplaces.rst index 1ca47f0..99ffe43 100644 --- a/site/source/support/user-manual/tuning/advanced-config/alt-marketplace.rst +++ b/site/source/user-manual/alt-marketplaces.rst @@ -1,8 +1,8 @@ -.. _alt-marketplace: +.. _alt-marketplaces: -=============== -Alt Marketplace -=============== +================ +Alt Marketplaces +================ EmbassyOS supports accessing alternative marketplaces. diff --git a/site/source/support/user-manual/walkthrough/backups.rst b/site/source/user-manual/backups/backup-create.rst similarity index 63% rename from site/source/support/user-manual/walkthrough/backups.rst rename to site/source/user-manual/backups/backup-create.rst index 2884dec..9e0f415 100644 --- a/site/source/support/user-manual/walkthrough/backups.rst +++ b/site/source/user-manual/backups/backup-create.rst @@ -1,15 +1,20 @@ -.. _backups: +.. _backup-create: -============== -Making Backups -============== +================ +Creating Backups +================ -There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop, desktop, or external drive on your network, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy. +There are 2 options for backing up your Embassy and service data: -.. note:: For remote backups, you will first need to configure the machine you want to backup to. Check our :ref:`Backup Setup` guide for your OS first. +1. Use a Shared Network Folder (recommended) on another device that connected to the same network as your Embassy, such as a laptop/desktop or external drive that is plugged into your laptop/desktop. +2. Use a physical drive, which must be externally powered or plugged into a powered USB hub. -Remote Backups --------------- +Shared Network Folder +--------------------- + +This is the recommended approach for creating backups. + +#. Follow instructions for creating a :ref:`Shared Network Folder` on your laptop/desktop. #. Go to the :ref:`Embassy tab`, then click on ``Create Backup``. @@ -48,13 +53,11 @@ Remote Backups .. figure:: /_static/images/config/embassy_backup4.png :width: 60% -Local Backups -------------- +Physical Drive +-------------- -#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered. +#. If your drive is self-powered, you can plug it directly into your Embassy USB 3.0 (blue) slot. If not, first plug the drive into a powered USB hub, then plug the hub into your Embassy USB 3.0 slot. -#. Plug in power to your hub or drive +#. Go to ``Embassy`` -> ``Create Backup`` -#. Boot Embassy and go to ``Embassy`` -> ``Create Backup`` - -#. +#. Select the drive diff --git a/site/source/user-manual/backups/backup-restore.rst b/site/source/user-manual/backups/backup-restore.rst new file mode 100644 index 0000000..b59e49a --- /dev/null +++ b/site/source/user-manual/backups/backup-restore.rst @@ -0,0 +1,5 @@ +.. _backup-restore: + +=================== +Restore From Backup +=================== \ No newline at end of file diff --git a/site/source/support/user-manual/configuration/backup-setup/backup-lin.rst b/site/source/user-manual/backups/cifs-setup/cifs-linux.rst similarity index 96% rename from site/source/support/user-manual/configuration/backup-setup/backup-lin.rst rename to site/source/user-manual/backups/cifs-setup/cifs-linux.rst index 8ff66d5..eec7e4a 100644 --- a/site/source/support/user-manual/configuration/backup-setup/backup-lin.rst +++ b/site/source/user-manual/backups/cifs-setup/cifs-linux.rst @@ -1,12 +1,9 @@ -.. _backup-lin: +.. _cifs-lin: ===== Linux ===== -Remote Backups --------------- - The following will guide you through the prerequisite configuration to backup to a Linux machine or an external drive that is attached to a Linux machine. .. tabs:: diff --git a/site/source/user-manual/backups/cifs-setup/cifs-mac.rst b/site/source/user-manual/backups/cifs-setup/cifs-mac.rst new file mode 100644 index 0000000..e11e128 --- /dev/null +++ b/site/source/user-manual/backups/cifs-setup/cifs-mac.rst @@ -0,0 +1,20 @@ +.. _cifs-mac: + +=== +Mac +=== + +The following will guide you through the prerequisite configuration to backup to a Mac machine or an external drive that is attached to a Mac machine. + +#. Go to system settings +#. Click sharing +#. Click file sharing +#. Click the + under shared folders +#. Add a folder +#. Click options +#. Enable Windows file sharing for the user you would like to use to authenticate +#. Click done +#. Enter the name of your macbook, as shown in the computer name field at the top of the sharing page into the hostname field in embassy ui +#. Enter the name of the folder as shown in the shared folders section as the path +#. Enter your macbook username and password for the user that you enabled windows file sharing for + diff --git a/site/source/user-manual/backups/cifs-setup/cifs-windows.rst b/site/source/user-manual/backups/cifs-setup/cifs-windows.rst new file mode 100644 index 0000000..f6657f9 --- /dev/null +++ b/site/source/user-manual/backups/cifs-setup/cifs-windows.rst @@ -0,0 +1,19 @@ +.. _cifs-win: + +======= +Windows +======= + +The following will guide you through the prerequisite configuration to backup to a Windows machine or an external drive that is attached to a Windows machine. + +#. Create a folder +#. Right click the folder +#. Select "properties" +#. Click the share tab +#. Click share... +#. Select a user you want to use for login, or select everyone +#. Click share +#. Enter your computer name into the hostname field in embassy ui (the name is shown after a \\ in the windows ui) +#. Enter the path that is shown after the hostname in the windows ui into the path field +#. Enter your username for the windows computer +#. Enter the password for the windows computer diff --git a/site/source/user-manual/backups/cifs-setup/index.rst b/site/source/user-manual/backups/cifs-setup/index.rst new file mode 100644 index 0000000..44d104f --- /dev/null +++ b/site/source/user-manual/backups/cifs-setup/index.rst @@ -0,0 +1,14 @@ +.. _cifs-setup: + +=========================== +Shared Network Folder Setup +=========================== + +Click your platform for detailed instructions on how to create a Shared Network Folder. + +.. toctree:: + :maxdepth: 2 + + cifs-linux + cifs-mac + cifs-windows diff --git a/site/source/user-manual/backups/index.rst b/site/source/user-manual/backups/index.rst new file mode 100644 index 0000000..9900659 --- /dev/null +++ b/site/source/user-manual/backups/index.rst @@ -0,0 +1,52 @@ +.. _backups: + +======= +Backups +======= + +In addition to safekeeping of a good master password, maintaining good backups are among the few major responsibilities required to keep the benefits and freedom that come with self-hosting. + +.. raw:: html + +
+ +
+ +.. topic-box:: + :title: Create + :link: backup-create + :icon: scylla-icon scylla-icon--memory-management + :class: large-5 + :anchor: View + + Create an encrypted backup of Embassy. + +.. topic-box:: + :title: Restore + :link: backup-restore + :icon: scylla-icon scylla-icon--comparison + :class: large-5 + :anchor: View + + Restore Embassy from a previous backup. + +.. topic-box:: + :title: SNF Setup + :link: cifs-setup/index + :icon: scylla-icon scylla-icon--networking + :class: large-5 + :anchor: Setup + + Setup a Shared Network Folder on your laptop/desktop. + +.. raw:: html + +
+ +.. toctree:: + :maxdepth: 1 + :hidden: + + backup-create + backup-restore + SNF Setup diff --git a/site/source/user-manual/connecting/index.rst b/site/source/user-manual/connecting/index.rst new file mode 100644 index 0000000..4a4ba8f --- /dev/null +++ b/site/source/user-manual/connecting/index.rst @@ -0,0 +1,40 @@ +.. _connecting: + +========== +Connecting +========== + +.. raw:: html + +
+ +
+ +.. topic-box:: + :title: LAN + :link: lan-setup + :icon: scylla-icon scylla-icon--home + :class: large-5 + :anchor: Setup + + Connect to Embassy over your Local Area Network. + +.. topic-box:: + :title: Tor + :link: tor-setup + :icon: scylla-icon scylla-icon--tor + :class: large-5 + :anchor: Setup + + Connect to Embassy over the Tor network. + +.. raw:: html + +
+ +.. toctree:: + :maxdepth: 1 + :hidden: + + lan-setup/index + tor-setup/index \ No newline at end of file diff --git a/site/source/support/user-manual/configuration/lan-setup/index.rst b/site/source/user-manual/connecting/lan-setup/index.rst similarity index 87% rename from site/source/support/user-manual/configuration/lan-setup/index.rst rename to site/source/user-manual/connecting/lan-setup/index.rst index 9060c9e..651c8a7 100644 --- a/site/source/support/user-manual/configuration/lan-setup/index.rst +++ b/site/source/user-manual/connecting/lan-setup/index.rst @@ -1,8 +1,8 @@ .. _lan-setup: -================= -Local (LAN) Setup -================= +========= +LAN Setup +========= When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access` is much faster and will allow access to your data, even with no Internet connection. Begin by setting up :ref:`Devices` before setting up a :ref:`Browser`. diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-browser/index.rst b/site/source/user-manual/connecting/lan-setup/lan-browser/index.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-browser/index.rst rename to site/source/user-manual/connecting/lan-setup/lan-browser/index.rst diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-brave.rst b/site/source/user-manual/connecting/lan-setup/lan-browser/lan-brave.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-brave.rst rename to site/source/user-manual/connecting/lan-setup/lan-browser/lan-brave.rst diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-chrome.rst b/site/source/user-manual/connecting/lan-setup/lan-browser/lan-chrome.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-chrome.rst rename to site/source/user-manual/connecting/lan-setup/lan-browser/lan-chrome.rst diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-ff.rst b/site/source/user-manual/connecting/lan-setup/lan-browser/lan-ff.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-ff.rst rename to site/source/user-manual/connecting/lan-setup/lan-browser/lan-ff.rst diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-safari.rst b/site/source/user-manual/connecting/lan-setup/lan-browser/lan-safari.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-safari.rst rename to site/source/user-manual/connecting/lan-setup/lan-browser/lan-safari.rst diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-os/index.rst b/site/source/user-manual/connecting/lan-setup/lan-os/index.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-os/index.rst rename to site/source/user-manual/connecting/lan-setup/lan-os/index.rst diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-android.rst b/site/source/user-manual/connecting/lan-setup/lan-os/lan-android.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-os/lan-android.rst rename to site/source/user-manual/connecting/lan-setup/lan-os/lan-android.rst diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-ios.rst b/site/source/user-manual/connecting/lan-setup/lan-os/lan-ios.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-os/lan-ios.rst rename to site/source/user-manual/connecting/lan-setup/lan-os/lan-ios.rst diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-linux.rst b/site/source/user-manual/connecting/lan-setup/lan-os/lan-linux.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-os/lan-linux.rst rename to site/source/user-manual/connecting/lan-setup/lan-os/lan-linux.rst diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-mac.rst b/site/source/user-manual/connecting/lan-setup/lan-os/lan-mac.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-os/lan-mac.rst rename to site/source/user-manual/connecting/lan-setup/lan-os/lan-mac.rst diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-windows.rst b/site/source/user-manual/connecting/lan-setup/lan-os/lan-windows.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-os/lan-windows.rst rename to site/source/user-manual/connecting/lan-setup/lan-os/lan-windows.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/index.rst b/site/source/user-manual/connecting/tor-setup/index.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/index.rst rename to site/source/user-manual/connecting/tor-setup/index.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-firefox/index.rst b/site/source/user-manual/connecting/tor-setup/tor-firefox/index.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-firefox/index.rst rename to site/source/user-manual/connecting/tor-setup/tor-firefox/index.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-android.rst b/site/source/user-manual/connecting/tor-setup/tor-firefox/torff-android.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-android.rst rename to site/source/user-manual/connecting/tor-setup/tor-firefox/torff-android.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-ios.rst b/site/source/user-manual/connecting/tor-setup/tor-firefox/torff-ios.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-ios.rst rename to site/source/user-manual/connecting/tor-setup/tor-firefox/torff-ios.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-linux.rst b/site/source/user-manual/connecting/tor-setup/tor-firefox/torff-linux.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-linux.rst rename to site/source/user-manual/connecting/tor-setup/tor-firefox/torff-linux.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-mac.rst b/site/source/user-manual/connecting/tor-setup/tor-firefox/torff-mac.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-mac.rst rename to site/source/user-manual/connecting/tor-setup/tor-firefox/torff-mac.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-windows.rst b/site/source/user-manual/connecting/tor-setup/tor-firefox/torff-windows.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-windows.rst rename to site/source/user-manual/connecting/tor-setup/tor-firefox/torff-windows.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-os/index.rst b/site/source/user-manual/connecting/tor-setup/tor-os/index.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-os/index.rst rename to site/source/user-manual/connecting/tor-setup/tor-os/index.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-os/tor-android.rst b/site/source/user-manual/connecting/tor-setup/tor-os/tor-android.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-os/tor-android.rst rename to site/source/user-manual/connecting/tor-setup/tor-os/tor-android.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-os/tor-ios.rst b/site/source/user-manual/connecting/tor-setup/tor-os/tor-ios.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-os/tor-ios.rst rename to site/source/user-manual/connecting/tor-setup/tor-os/tor-ios.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-os/tor-linux.rst b/site/source/user-manual/connecting/tor-setup/tor-os/tor-linux.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-os/tor-linux.rst rename to site/source/user-manual/connecting/tor-setup/tor-os/tor-linux.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-os/tor-mac.rst b/site/source/user-manual/connecting/tor-setup/tor-os/tor-mac.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-os/tor-mac.rst rename to site/source/user-manual/connecting/tor-setup/tor-os/tor-mac.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-os/tor-windows.rst b/site/source/user-manual/connecting/tor-setup/tor-os/tor-windows.rst similarity index 100% rename from site/source/support/user-manual/configuration/tor-setup/tor-os/tor-windows.rst rename to site/source/user-manual/connecting/tor-setup/tor-os/tor-windows.rst diff --git a/site/source/support/user-manual/tuning/tune-embassy-os.rst b/site/source/user-manual/customize.rst similarity index 88% rename from site/source/support/user-manual/tuning/tune-embassy-os.rst rename to site/source/user-manual/customize.rst index 54237ab..9cc02f1 100644 --- a/site/source/support/user-manual/tuning/tune-embassy-os.rst +++ b/site/source/user-manual/customize.rst @@ -1,13 +1,13 @@ -.. _tune-embassy-os: +.. _customize: -=============== -Customizing EOS -=============== +========= +Customize +========= .. _device-name: -Set Device Name ---------------- +Name Your Device +---------------- Here you can change the name of your Embassy! @@ -31,8 +31,8 @@ Here you can change the name of your Embassy! .. _reorder: -Reorder Service Page --------------------- +Reorder Services +---------------- You may customize the layout of your Services by re-arranging them to your liking. diff --git a/site/source/support/user-manual/walkthrough/overview.rst b/site/source/user-manual/dashboard-overview.rst similarity index 89% rename from site/source/support/user-manual/walkthrough/overview.rst rename to site/source/user-manual/dashboard-overview.rst index 91e11df..0f27013 100644 --- a/site/source/support/user-manual/walkthrough/overview.rst +++ b/site/source/user-manual/dashboard-overview.rst @@ -1,7 +1,7 @@ -.. _overview: +.. _dashboard-overview: ================== -EmbassyOS Overview +Dashboard Overview ================== .. _services-tab: @@ -9,12 +9,12 @@ EmbassyOS Overview Services Tab ------------ -The Services Tab will show you all of your currently installed :ref:`Services`, or in the case of a fresh install, no Services. You can reorder this layout to your liking with the ``Reorder`` button in the top right. You can see a demo of this :ref:`here`. +The Services Tab will show you all of your currently installed :ref:`Services`, or in the case of a fresh install, no Services. You can reorder this layout to your liking with the ``Reorder`` button in the top right. You can see a demo of this :ref:`here`. .. figure:: /_static/images/walkthrough/servicestab.png :width: 60% -Click on any service in order to see its :ref:`Service Page`. +Click on any service in order to see its :ref:`Service Page`. .. figure:: /_static/images/walkthrough/servicepage.png :width: 60% @@ -42,7 +42,7 @@ The Insights section gives you basic information on your Embassy, monitoring of Settings ======== -The Settings section lets you change preferences, and manage `Connectivity` and Active Sessions. See the documentation on :ref:`Configuration` for more details. +The Settings section lets you change preferences, and manage `Connectivity` and Active Sessions. See the documentation on :ref:`Configuration` for more details. .. _power: diff --git a/site/source/user-manual/device-guides/dg-android.rst b/site/source/user-manual/device-guides/dg-android.rst new file mode 100644 index 0000000..98ca770 --- /dev/null +++ b/site/source/user-manual/device-guides/dg-android.rst @@ -0,0 +1,11 @@ +.. _dg-android: + +======= +Android +======= + +.. tip:: Please see Android's :ref:`Known Limitations` to understand what is currently not possible on these devices + +* :ref:`Connecting over LAN ` - For a fast and secure connection while on your Embassy's local network +* :ref:`Connecting over Tor ` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy. +* :ref:`Tor Firefox Config ` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers. \ No newline at end of file diff --git a/site/source/user-manual/device-guides/dg-ios.rst b/site/source/user-manual/device-guides/dg-ios.rst new file mode 100644 index 0000000..0d6e927 --- /dev/null +++ b/site/source/user-manual/device-guides/dg-ios.rst @@ -0,0 +1,9 @@ +.. _dg-ios: + +=== +iOS +=== + +.. tip:: Please see iOS's :ref:`Known Limitations` to understand what is currently not possible on these devices + +* :ref:`Connecting over LAN ` - For a fast and secure connection while on your Embassy's local network \ No newline at end of file diff --git a/site/source/user-manual/device-guides/dg-linux.rst b/site/source/user-manual/device-guides/dg-linux.rst new file mode 100644 index 0000000..be7cded --- /dev/null +++ b/site/source/user-manual/device-guides/dg-linux.rst @@ -0,0 +1,12 @@ +.. _dg-linux: + +===== +Linux +===== + +.. tip:: Please see Linux's :ref:`Known Limitations` to understand what is currently not possible on these devices + +* :ref:`Connecting over LAN ` - For a fast and secure connection while on your Embassy's local network +* :ref:`Connecting over Tor ` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy. +* :ref:`Tor Firefox Config ` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers. +* :ref:`SNF Setup ` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups. \ No newline at end of file diff --git a/site/source/user-manual/device-guides/dg-mac.rst b/site/source/user-manual/device-guides/dg-mac.rst new file mode 100644 index 0000000..38f5471 --- /dev/null +++ b/site/source/user-manual/device-guides/dg-mac.rst @@ -0,0 +1,12 @@ +.. _dg-mac: + +=== +Mac +=== + +.. tip:: Please see Mac's :ref:`Known Limitations` to understand what is currently not possible on these devices + +* :ref:`Connecting over LAN ` - For a fast and secure connection while on your Embassy's local network +* :ref:`Connecting over Tor ` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy. +* :ref:`Tor Firefox Config ` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers. +* :ref:`SNF Setup ` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups. diff --git a/site/source/user-manual/device-guides/dg-windows.rst b/site/source/user-manual/device-guides/dg-windows.rst new file mode 100644 index 0000000..f68b2c9 --- /dev/null +++ b/site/source/user-manual/device-guides/dg-windows.rst @@ -0,0 +1,12 @@ +.. _dg-windows: + +======= +Windows +======= + +.. tip:: Please see Window's :ref:`Known Limitations` to understand what is currently not possible on these devices. + +* :ref:`Connecting over LAN ` - For a fast and secure connection while on your Embassy's local network +* :ref:`Connecting over Tor ` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy. +* :ref:`Tor Firefox Config ` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers. +* :ref:`SNF Setup ` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups. diff --git a/site/source/support/user-manual/getting-started/device-guides/index.rst b/site/source/user-manual/device-guides/index.rst similarity index 91% rename from site/source/support/user-manual/getting-started/device-guides/index.rst rename to site/source/user-manual/device-guides/index.rst index 03bd5cb..9df613a 100644 --- a/site/source/support/user-manual/getting-started/device-guides/index.rst +++ b/site/source/user-manual/device-guides/index.rst @@ -14,3 +14,4 @@ Guides to get connected with or improve your Embassy by device-type. dg-windows dg-android dg-ios + limitations/index diff --git a/site/source/support/user-manual/configuration/limitations/index.rst b/site/source/user-manual/device-guides/limitations/index.rst similarity index 95% rename from site/source/support/user-manual/configuration/limitations/index.rst rename to site/source/user-manual/device-guides/limitations/index.rst index f26d07d..0a49da9 100644 --- a/site/source/support/user-manual/configuration/limitations/index.rst +++ b/site/source/user-manual/device-guides/limitations/index.rst @@ -7,7 +7,7 @@ Known Limitations The following pages describe functionality that is known to be missing from certain platforms. Please bother the appropriate company or developers until they have been remedied. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 lim-linux lim-mac diff --git a/site/source/support/user-manual/configuration/limitations/lim-android.rst b/site/source/user-manual/device-guides/limitations/lim-android.rst similarity index 100% rename from site/source/support/user-manual/configuration/limitations/lim-android.rst rename to site/source/user-manual/device-guides/limitations/lim-android.rst diff --git a/site/source/support/user-manual/configuration/limitations/lim-ios.rst b/site/source/user-manual/device-guides/limitations/lim-ios.rst similarity index 100% rename from site/source/support/user-manual/configuration/limitations/lim-ios.rst rename to site/source/user-manual/device-guides/limitations/lim-ios.rst diff --git a/site/source/support/user-manual/configuration/limitations/lim-linux.rst b/site/source/user-manual/device-guides/limitations/lim-linux.rst similarity index 100% rename from site/source/support/user-manual/configuration/limitations/lim-linux.rst rename to site/source/user-manual/device-guides/limitations/lim-linux.rst diff --git a/site/source/support/user-manual/configuration/limitations/lim-mac.rst b/site/source/user-manual/device-guides/limitations/lim-mac.rst similarity index 100% rename from site/source/support/user-manual/configuration/limitations/lim-mac.rst rename to site/source/user-manual/device-guides/limitations/lim-mac.rst diff --git a/site/source/support/user-manual/configuration/limitations/lim-windows.rst b/site/source/user-manual/device-guides/limitations/lim-windows.rst similarity index 100% rename from site/source/support/user-manual/configuration/limitations/lim-windows.rst rename to site/source/user-manual/device-guides/limitations/lim-windows.rst diff --git a/site/source/support/user-manual/walkthrough/password.rst b/site/source/user-manual/forgot-password.rst similarity index 94% rename from site/source/support/user-manual/walkthrough/password.rst rename to site/source/user-manual/forgot-password.rst index 6a1fdf4..08045bc 100644 --- a/site/source/support/user-manual/walkthrough/password.rst +++ b/site/source/user-manual/forgot-password.rst @@ -9,7 +9,7 @@ There is currently no way to reset you Embassy master password through a standar SSH/Linux --------- -If you already have :ref:`SSH keys registered with your Embassy` **OR** you have access to a Linux computer, you can reset your Embassy password without losing any data. +If you already have :ref:`SSH keys registered with your Embassy` **OR** you have access to a Linux computer, you can reset your Embassy password without losing any data. SSH === diff --git a/site/source/user-manual/index.rst b/site/source/user-manual/index.rst new file mode 100644 index 0000000..fda18f3 --- /dev/null +++ b/site/source/user-manual/index.rst @@ -0,0 +1,27 @@ +.. _user-manual: + +=========== +User Manual +=========== + +Welcome to the EmbassyOS user manual. Here you will discover all that you Embassy can do! + +.. toctree:: + :includehidden: + :maxdepth: 2 + + initial-setup + connecting/index + dashboard-overview + customize + backups/index + managing-services/index + service-guides/index + sessions + wifi + ssh + alt-marketplaces + updating + forgot-password + device-guides/index + misc-guides/index diff --git a/site/source/support/user-manual/getting-started/initial-setup.rst b/site/source/user-manual/initial-setup.rst similarity index 89% rename from site/source/support/user-manual/getting-started/initial-setup.rst rename to site/source/user-manual/initial-setup.rst index bb87db3..a315173 100644 --- a/site/source/support/user-manual/getting-started/initial-setup.rst +++ b/site/source/user-manual/initial-setup.rst @@ -4,8 +4,8 @@ Initial Setup ============= -Connect and Power Up --------------------- +Powering On +----------- Check out our quick setup video below, and follow along with the steps in this guide: @@ -22,12 +22,12 @@ Embassy will initialize, which may take 10-15min. You will hear 2 distinct soun * "bep" - Starting up * "chime" - Embassy is ready -Setup Your Embassy ------------------- +Connecting +---------- 1. Ensure the device you are using (desktop/laptop or mobile) is connected to the same network as your router. -.. caution:: Sometmies a router will have a "guest WiFi network," which might be different than the network your Embassy is placed on via ethernet. +.. caution:: Sometimes a router will have a "guest WiFi network," which might be different than the network your Embassy is placed on via ethernet. 2. Visit ``embassy.local`` from your web browser. You will be prompted to enter your :ref:`Product Key`. This is found on the bottom side of your device. @@ -79,15 +79,6 @@ Setup Your Embassy Your Embassy is now hosted on the private web! After setup is complete you will be presented with connection information. You can view and manage your Embassy by visiting its unique Tor Address from any Tor-enabled browser, or by accessing it's ``.local`` address from your LAN (see :ref:`LAN Setup` for assistance). -Enjoy! ------- - -.. figure:: /_static/images/setup/setup5.png - :width: 60% - :alt: Fresh Embassy - -Upon accessing your Embassy for the first time, you will be greeted with an empty Services page. Start9 firmly believe that the only software that should be on your device is the software you choose to be on there. So go ahead and visit the Marketplace to get your first Service!! - Troubleshooting --------------- diff --git a/site/source/support/user-manual/services/managing-services/index.rst b/site/source/user-manual/managing-services/index.rst similarity index 70% rename from site/source/support/user-manual/services/managing-services/index.rst rename to site/source/user-manual/managing-services/index.rst index f86fb0a..b4b94ac 100644 --- a/site/source/support/user-manual/services/managing-services/index.rst +++ b/site/source/user-manual/managing-services/index.rst @@ -4,10 +4,10 @@ Managing Services ================= -An overview of Services and Marketplaces on EmbassyOS. +EmbassyOS provides a rich interface for working with services installed from the Marketplace. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 service-overview service-install @@ -17,5 +17,4 @@ An overview of Services and Marketplaces on EmbassyOS. service-actions service-interfaces service-logs - service-donate service-updates diff --git a/site/source/support/user-manual/services/managing-services/service-actions.rst b/site/source/user-manual/managing-services/service-actions.rst similarity index 56% rename from site/source/support/user-manual/services/managing-services/service-actions.rst rename to site/source/user-manual/managing-services/service-actions.rst index c071b79..db111d0 100644 --- a/site/source/support/user-manual/services/managing-services/service-actions.rst +++ b/site/source/user-manual/managing-services/service-actions.rst @@ -4,12 +4,15 @@ Actions ======= -Actions are defined by the service package developer, and can provide the ability to do resets or other miscellaneous administrative tasks. The most simple of these is to remove a service from your Embassy. +Actions are defined by the service package developer, and can provide the ability to do resets or other miscellaneous administrative tasks. Actions may or may not require user input. -.. _uninstalling: +Default Actions +--------------- -Un-installing -------------- +Every service comes with a set up default Actions that can be run. Currently, the only default action is "Uninstall". + +Uninstall +========= .. warning:: THIS WILL DELETE ALL DATA FOR THIS SERVICE, PLEASE BE SURE YOU WANT TO DO THIS! @@ -17,3 +20,8 @@ To remove a service, navigate to the :ref:`Services tab` *> [Servi .. figure:: /_static/images/services/acts.png :width: 60% + +Custom Actions +-------------- + +Service developers can define any number of arbitrary actions for their service. diff --git a/site/source/support/user-manual/services/managing-services/service-config.rst b/site/source/user-manual/managing-services/service-config.rst similarity index 100% rename from site/source/support/user-manual/services/managing-services/service-config.rst rename to site/source/user-manual/managing-services/service-config.rst diff --git a/site/source/support/user-manual/services/managing-services/service-install.rst b/site/source/user-manual/managing-services/service-install.rst similarity index 89% rename from site/source/support/user-manual/services/managing-services/service-install.rst rename to site/source/user-manual/managing-services/service-install.rst index 10c0732..f307683 100644 --- a/site/source/support/user-manual/services/managing-services/service-install.rst +++ b/site/source/user-manual/managing-services/service-install.rst @@ -6,7 +6,7 @@ Installing .. note:: Some services have :ref:`dependencies` on other services. Adding, updating, or removing a service can sometimes have requirements or consequences for other services. Your Embassy will always inform you of these issues along the way. -To add a new service, simply find it's listing inside the :ref:`Service Marketplace ` tab: *[Service Name] >* ``Install``. Let's install Synapse as an example: +To add a new service, simply find its listing inside the Marketplace: *[Service Name] >* ``Install``. Let's install Synapse as an example: .. figure:: /_static/images/services/service0.png :width: 60% diff --git a/site/source/support/user-manual/services/managing-services/service-instructions.rst b/site/source/user-manual/managing-services/service-instructions.rst similarity index 100% rename from site/source/support/user-manual/services/managing-services/service-instructions.rst rename to site/source/user-manual/managing-services/service-instructions.rst diff --git a/site/source/support/user-manual/services/managing-services/service-interfaces.rst b/site/source/user-manual/managing-services/service-interfaces.rst similarity index 54% rename from site/source/support/user-manual/services/managing-services/service-interfaces.rst rename to site/source/user-manual/managing-services/service-interfaces.rst index 5b5d187..116c9ac 100644 --- a/site/source/support/user-manual/services/managing-services/service-interfaces.rst +++ b/site/source/user-manual/managing-services/service-interfaces.rst @@ -4,7 +4,7 @@ Interfaces ========== -Interfaces are URLs that a :ref:`Service` uses to communicate in various ways with other software. Many Services will only have one interface, perhaps with a Tor and LAN address, to denote where it is hosted / accessed. Other services, such as Bitcoin or Lightning Nodes, may have several interfaces for different use-cases. +Interfaces are URLs that a :ref:`Service` uses to communicate in various ways with other software. Many Services will only have one interface, perhaps with a Tor and LAN address, to denote where it is hosted / accessed. Other services, such as Bitcoin or Lightning Nodes, may have several interfaces for different use-cases. .. figure:: /_static/images/services/service-ints.png :width: 60% diff --git a/site/source/support/user-manual/services/managing-services/service-logs.rst b/site/source/user-manual/managing-services/service-logs.rst similarity index 100% rename from site/source/support/user-manual/services/managing-services/service-logs.rst rename to site/source/user-manual/managing-services/service-logs.rst diff --git a/site/source/user-manual/managing-services/service-overview.rst b/site/source/user-manual/managing-services/service-overview.rst new file mode 100644 index 0000000..3ad2a9c --- /dev/null +++ b/site/source/user-manual/managing-services/service-overview.rst @@ -0,0 +1,32 @@ +.. _service-overview: + +======== +Overview +======== + +Services are very similar to Applications on a mobile device. The biggest differences are that they are often designed to run constantly, with 24/7 availability for when a user requires them. This is why they are called services: they are always ready to serve users! + +.. figure:: /_static/images/services/service8.png + :width: 60% + +In the image above, we see an example of a Service's homescreen, where you can access all the information and utilities of a particular service. + +Below, we highlight the quick, need-to-know information of a Service that a user will want to see right away. + +.. figure:: /_static/images/services/service00.png + :width: 60% + +.. _service-status: + +We can see the Service (Embassy Pages in this case), its ``Status``, ``Health Checks`` (if it has any), ``Dependencies`` (if it has any), and the ability to ``Start`` or ``Stop`` the Service, as well as ``Launch UI`` if it has a :ref:`Web Interface `. Here's a breakdown of what each of these means: + +- Status: + - ```Needs Config```: The Service needs your attention in making a configuration decision. There will always be default options available to you. + - ```Stopping...```: Service is being stopped + - ```Stopped```: Service is installed and configured, but not currently running. + - ```Starting...```: Service is booting up + - ```Running```: Service is running +- Health Checks: This is a critical feature of EmbassyOS. Health Checks are configured by the service packager in order to quickly convey to the user what is happening with their service, and possible actions they may want to take. Learn more about :ref:`Health Checks `. +- Dependencies: A service may require another service, called a dependency, in order to work. These may be optional, or required. Learn more about :ref:`Dependencies `. +- Start / Stop: Self-explanatory, use these buttons to start or stop a service. +- Launch UI: If available, this will open the User Interface (UI) for the service in a new browser tab. Learn more about :ref:`Web UIs`. diff --git a/site/source/support/user-manual/services/managing-services/service-properties.rst b/site/source/user-manual/managing-services/service-properties.rst similarity index 100% rename from site/source/support/user-manual/services/managing-services/service-properties.rst rename to site/source/user-manual/managing-services/service-properties.rst diff --git a/site/source/support/user-manual/services/managing-services/service-updates.rst b/site/source/user-manual/managing-services/service-updates.rst similarity index 100% rename from site/source/support/user-manual/services/managing-services/service-updates.rst rename to site/source/user-manual/managing-services/service-updates.rst diff --git a/site/source/support/user-manual/tuning/diy.rst b/site/source/user-manual/misc-guides/diy.rst similarity index 95% rename from site/source/support/user-manual/tuning/diy.rst rename to site/source/user-manual/misc-guides/diy.rst index 3a5bdc3..9ed27de 100644 --- a/site/source/support/user-manual/tuning/diy.rst +++ b/site/source/user-manual/misc-guides/diy.rst @@ -64,14 +64,14 @@ Getting EmbassyOS After building your device, you need a copy of EmbassyOS. -Getting EmbassyOS: Purchasing +Purchase from Start9 ............................. -- You can purchase EmbassyOS `here `_. This is by far the easiest path to get up and running. +- You can purchase a copy of EmbassyOS `here `_. This is by far the easiest path to get up and running. - Depending on your Internet speed, the download should take between 5 and 30 minutes. -Getting EmbassyOS: Building from Source +Build from Source ....................................... - If you prefer to build EmbassyOS from source, you can do so following our guide on the `Start9 GitHub `_. diff --git a/site/source/user-manual/misc-guides/index.rst b/site/source/user-manual/misc-guides/index.rst new file mode 100644 index 0000000..29264a9 --- /dev/null +++ b/site/source/user-manual/misc-guides/index.rst @@ -0,0 +1,14 @@ +.. _misc-guides: + +=========== +Misc Guides +=========== + +Device and platform-specific guides to get the most out of your Embassy. + +.. toctree:: + :maxdepth: 1 + + diy + ssh-tor + migrate-02 \ No newline at end of file diff --git a/site/source/support/user-manual/getting-started/recover-02.rst b/site/source/user-manual/misc-guides/migrate-02.rst similarity index 84% rename from site/source/support/user-manual/getting-started/recover-02.rst rename to site/source/user-manual/misc-guides/migrate-02.rst index a1b0015..33d0ff0 100644 --- a/site/source/support/user-manual/getting-started/recover-02.rst +++ b/site/source/user-manual/misc-guides/migrate-02.rst @@ -1,24 +1,16 @@ -.. _recover-02x: +.. _migrate-02: -=================== -Migrate v0.2.x Data -=================== - -.. contents:: - :depth: 4 - :local: - -Migrate Embassy Series 0.2.x Data ---------------------------------- +================== +Migrate from 0.2.x +================== This guide will cover how to upgrade from EmbassyOS version 0.2.x to version 0.3.0. -If you purchased the upgrade kit from us you can skip to :ref:`backing up ` unless you received your kit before we completed 0.3.0, in which case please skip to :ref:`flashing ` as you will need to flash 0.3.0 onto your SD card to continue migrating. +Hardware Requirements +--------------------- -Additional Hardware -=================== - -If you have not purchased an `upgrade kit `_ from us you'll need the following equipment: +.. note:: + If you purchased the `upgrade kit `_ from Start9, you can skip to :ref:`Instructions `. #. `16GB microSD card `_ @@ -28,21 +20,12 @@ If you have not purchased an `upgrade kit `_ for getting data from your SD card. +.. _migrate-02-instructions: + Instructions -============ +------------ -.. _recover-02-flashing: - -Flashing -........ - -#. Once you have all these you will need to download an 0.3.0 image from https://images.start9.com. This is free for all existing users. Anyone who is running 0.2.x who compiled it themselves will need to either compile 0.3.0 themselves or purchase an 0.3.0 image. - -#. Once you have the image, flash it on to the 16GB SD card - the new one, **NOT** the one currently in your Embassy! - -.. tip:: The flashing software we recommend is `Balena Etcher `_ - -.. _recover-02-backup: +.. _migrate-02-backing-up: Backing up .......... @@ -55,10 +38,24 @@ If you're unsure how to do this - please follow `this `_ from Start9, you can skip to :ref:`Migrate `. + +#. Once you have all these you will need to download an 0.3.0 image from https://images.start9.com. This is free for all existing users. Anyone who is running 0.2.x who compiled it themselves will need to either compile 0.3.0 themselves or purchase an 0.3.0 image. + +#. Once you have the image, flash it on to the 16GB SD card - the new one, **NOT** the one currently in your Embassy! + +.. tip:: The flashing software we recommend is `Balena Etcher `_ + +.. _migrate-02-migrate: + +Migrate +....... #. Begin by going into your Embassy, stopping all running services, and shutting down the device in the Embassy tab. diff --git a/site/source/support/user-manual/tuning/advanced-config/ssh-tor.rst b/site/source/user-manual/misc-guides/ssh-tor.rst similarity index 97% rename from site/source/support/user-manual/tuning/advanced-config/ssh-tor.rst rename to site/source/user-manual/misc-guides/ssh-tor.rst index 029f04a..b3be574 100644 --- a/site/source/support/user-manual/tuning/advanced-config/ssh-tor.rst +++ b/site/source/user-manual/misc-guides/ssh-tor.rst @@ -6,7 +6,7 @@ SSH Over Tor .. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause while using SSH access. -.. note:: The following guide requires that you have already added an `SSH key to your Embassy`. +.. note:: The following guide requires that you have already added an `SSH key to your Embassy`. This is currently only supported on Linux, but may work on Windows with `Torifier `_. diff --git a/site/source/support/user-manual/tuning/service-guides/bitcoin.rst b/site/source/user-manual/service-guides/bitcoin.rst similarity index 98% rename from site/source/support/user-manual/tuning/service-guides/bitcoin.rst rename to site/source/user-manual/service-guides/bitcoin.rst index fe4d29c..cfbec3c 100644 --- a/site/source/support/user-manual/tuning/service-guides/bitcoin.rst +++ b/site/source/user-manual/service-guides/bitcoin.rst @@ -108,7 +108,7 @@ Instructions for accessing the bitcoind service in order to issue commands direc .. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access. -1. First, you will need SSH access. Please see the :ref:`setup instructions ` for details. +1. First, you will need SSH access. Please see the :ref:`setup instructions ` for details. 2. Access your Embassy and then you can interact with the bitcoind docker container using the following syntax:: sudo docker exec bitcoind bitcoin-cli COMMAND diff --git a/site/source/support/user-manual/tuning/service-guides/index.rst b/site/source/user-manual/service-guides/index.rst similarity index 59% rename from site/source/support/user-manual/tuning/service-guides/index.rst rename to site/source/user-manual/service-guides/index.rst index 52891b0..a9c95e4 100644 --- a/site/source/support/user-manual/tuning/service-guides/index.rst +++ b/site/source/user-manual/service-guides/index.rst @@ -4,10 +4,10 @@ Service Guides ============== -These guides will help you to setup external tools to connect or interact with specific :ref:`Services`, such as a chat client or :ref:`Bitcoin` wallet. +These guides will help you to setup external tools to connect or interact with specific :ref:`Services`, such as a chat client or :ref:`Bitcoin` wallet. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 vaultwarden matrix diff --git a/site/source/support/user-manual/tuning/service-guides/lightning.rst b/site/source/user-manual/service-guides/lightning.rst similarity index 100% rename from site/source/support/user-manual/tuning/service-guides/lightning.rst rename to site/source/user-manual/service-guides/lightning.rst diff --git a/site/source/support/user-manual/tuning/service-guides/matrix.rst b/site/source/user-manual/service-guides/matrix.rst similarity index 83% rename from site/source/support/user-manual/tuning/service-guides/matrix.rst rename to site/source/user-manual/service-guides/matrix.rst index ca792b5..9f5d703 100644 --- a/site/source/support/user-manual/tuning/service-guides/matrix.rst +++ b/site/source/user-manual/service-guides/matrix.rst @@ -4,11 +4,6 @@ Matrix ====== -.. _matrix-setup: - -Guides ------- - Check out our `Synapse video `_ for features and setup! .. youtube:: PtwQsybFapo diff --git a/site/source/support/user-manual/tuning/service-guides/vaultwarden.rst b/site/source/user-manual/service-guides/vaultwarden.rst similarity index 96% rename from site/source/support/user-manual/tuning/service-guides/vaultwarden.rst rename to site/source/user-manual/service-guides/vaultwarden.rst index 580518f..21f02ba 100644 --- a/site/source/support/user-manual/tuning/service-guides/vaultwarden.rst +++ b/site/source/user-manual/service-guides/vaultwarden.rst @@ -4,17 +4,15 @@ Vaultwarden =========== -Vaultwarden Setup Guide and Integrations ----------------------------------------- - .. note:: The version of Bitwarden server used on the Embassy is a fork called "Vaultwarden." Despite this, it still functions with several of the apps/integrations that are built for, and still named after, "Bitwarden." We apologize for any confusion this may cause. Check out our `Vaultwarden video `_ for basic features and setup! .. youtube:: YcxxVHpm9j0 -Vaultwarden Vault (WebUI) -========================= + +Web Vault +--------- 1. First we will open up our Embassy and go to the Marketplace tab, select Vaultwarden, and install if you have not already done so. @@ -28,8 +26,8 @@ Vaultwarden Vault (WebUI) 5. Back at the main page for your vault, let's do a quick example login. We can setup a new folder here and save new login. For our example, we're going to use our FileBrowser instance. So click 'Add item,' then we'll fill in some test information. A name for the entry, a username, password, and the website we want to log in to. Then click 'Save.' -Bitwarden Browser Extension -=========================== +Browser Extension +----------------- The Bitwarden browser extension will only work with Tor browser or Firefox, since those are the only two browsers capable of using Tor, or in other words, access .onion URLs. Brave Browser can also access .onion URLs, but only in special tabs, not in extension, so the Bitwarden extension will not work on Brave. @@ -40,10 +38,10 @@ The Bitwarden browser extension will only work with Tor browser or Firefox, sinc 3. Now you can click on the extension again, click 'Log In,' and enter your credentials. That's it, the extension is all set up! Mobile Apps -=========== +----------- Android -....... +======= You will need to :ref:`Setup Tor ` on your device first. @@ -54,7 +52,7 @@ You will need to :ref:`Setup Tor ` on your device first. #. Go ahead and tap 'Log In,' enter your credentials, and you can access your Bitwarden app / Vaultwarden server. iOS -... +=== Unfortunately, the iOS app does not support Tor, so currently the Bitwarden app can only be synced on LAN. Once synced, your app and passwords will be cached and available when you are on the go, and you will only need to be on LAN to update any edits to your vault. @@ -67,12 +65,12 @@ You will need to :ref:`Setup LAN ` on your device first. #. Go ahead and tap 'Log In,' enter your credentials, and you can access your Bitwarden app / Vaultwarden server. Desktop Apps -============ +------------ The desktop app is a bit more finicky, and arguably much less useful than the mobile and browser solutions, but below are the known good (tested) configurations if you'd like to use it. Linux -..... +===== First, be sure to :ref:`Setup Tor ` natively. @@ -85,7 +83,7 @@ First, be sure to :ref:`Setup Tor ` natively. Alternatively, you may be able to run using your LAN address, but this has proven finicky, especially on Debian/Ubuntu systems. You will have better luck if you have the Root CA installed at the OS level. First, be sure to :ref:`Setup LAN ` natively. Mac -... +=== #. Download the `Bitwarden Desktop app `_. @@ -102,7 +100,7 @@ Mac #. You can now log in to your vault. Windows -....... +======= #. Download the `Bitwarden Desktop app `_. diff --git a/site/source/support/user-manual/walkthrough/sessions.rst b/site/source/user-manual/sessions.rst similarity index 100% rename from site/source/support/user-manual/walkthrough/sessions.rst rename to site/source/user-manual/sessions.rst diff --git a/site/source/support/user-manual/tuning/advanced-config/ssh-setup.rst b/site/source/user-manual/ssh.rst similarity index 97% rename from site/source/support/user-manual/tuning/advanced-config/ssh-setup.rst rename to site/source/user-manual/ssh.rst index f98440f..23e7979 100644 --- a/site/source/support/user-manual/tuning/advanced-config/ssh-setup.rst +++ b/site/source/user-manual/ssh.rst @@ -1,7 +1,7 @@ -.. _ssh-setup: +.. _ssh: ========= -SSH Setup +Using SSH ========= .. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause while using SSH access. diff --git a/site/source/support/user-manual/walkthrough/updates.rst b/site/source/user-manual/updating.rst similarity index 91% rename from site/source/support/user-manual/walkthrough/updates.rst rename to site/source/user-manual/updating.rst index 98c98d9..a8095c0 100644 --- a/site/source/support/user-manual/walkthrough/updates.rst +++ b/site/source/user-manual/updating.rst @@ -22,7 +22,6 @@ Enable Auto Check for Updates #. Click "Auto Check for Updates" and click Enable #. If there is an update available, you will be prompted to install it. #. While updating, your Embassy will emit a gentle chime every 20 seconds. -#. You can also enable :ref:`automatic update checks` in the ``Embassy`` tab -> Settings -> Preferences. .. note:: Ensure you have a stable Internet connection, and do not unplug your Embassy during an update. Updates usually complete within a few minutes, but depending on the size of the update and your Internet bandwidth, they can sometimes take up to an hour. diff --git a/site/source/support/user-manual/configuration/wifi.rst b/site/source/user-manual/wifi.rst similarity index 100% rename from site/source/support/user-manual/configuration/wifi.rst rename to site/source/user-manual/wifi.rst diff --git a/sphinx-scylladb-theme b/sphinx-scylladb-theme index ba52774..062eaab 160000 --- a/sphinx-scylladb-theme +++ b/sphinx-scylladb-theme @@ -1 +1 @@ -Subproject commit ba52774017912bf99f415878cc51ff4eca23b5c7 +Subproject commit 062eaabc57a6743006d3d6e3f4043abff13b66e6