diff --git a/poetry.lock b/poetry.lock index 82f539b..3aaf189 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.4.2 and should not be changed by hand. +# This file is automatically @generated by Poetry and should not be changed by hand. [[package]] name = "alabaster" @@ -14,19 +14,22 @@ files = [ [[package]] name = "babel" -version = "2.12.1" +version = "2.13.0" description = "Internationalization utilities" category = "main" optional = false python-versions = ">=3.7" files = [ - {file = "Babel-2.12.1-py3-none-any.whl", hash = "sha256:b4246fb7677d3b98f501a39d43396d3cafdc8eadb045f4a31be01863f655c610"}, - {file = "Babel-2.12.1.tar.gz", hash = "sha256:cc2d99999cd01d44420ae725a21c9e3711b3aadc7976d6147f622d8581963455"}, + {file = "Babel-2.13.0-py3-none-any.whl", hash = "sha256:fbfcae1575ff78e26c7449136f1abbefc3c13ce542eeb13d43d50d8b047216ec"}, + {file = "Babel-2.13.0.tar.gz", hash = "sha256:04c3e2d28d2b7681644508f836be388ae49e0cfe91465095340395b60d00f210"}, ] [package.dependencies] pytz = {version = ">=2015.7", markers = "python_version < \"3.9\""} +[package.extras] +dev = ["freezegun (>=1.0,<2.0)", "pytest (>=6.0)", "pytest-cov"] + [[package]] name = "beautifulsoup4" version = "4.12.2" @@ -60,87 +63,102 @@ files = [ [[package]] name = "charset-normalizer" -version = "3.2.0" +version = "3.3.0" description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." category = "main" optional = false python-versions = ">=3.7.0" files = [ - {file = "charset-normalizer-3.2.0.tar.gz", hash = "sha256:3bb3d25a8e6c0aedd251753a79ae98a093c7e7b471faa3aa9a93a81431987ace"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:0b87549028f680ca955556e3bd57013ab47474c3124dc069faa0b6545b6c9710"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:7c70087bfee18a42b4040bb9ec1ca15a08242cf5867c58726530bdf3945672ed"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:a103b3a7069b62f5d4890ae1b8f0597618f628b286b03d4bc9195230b154bfa9"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:94aea8eff76ee6d1cdacb07dd2123a68283cb5569e0250feab1240058f53b623"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:db901e2ac34c931d73054d9797383d0f8009991e723dab15109740a63e7f902a"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b0dac0ff919ba34d4df1b6131f59ce95b08b9065233446be7e459f95554c0dc8"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:193cbc708ea3aca45e7221ae58f0fd63f933753a9bfb498a3b474878f12caaad"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:09393e1b2a9461950b1c9a45d5fd251dc7c6f228acab64da1c9c0165d9c7765c"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:baacc6aee0b2ef6f3d308e197b5d7a81c0e70b06beae1f1fcacffdbd124fe0e3"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:bf420121d4c8dce6b889f0e8e4ec0ca34b7f40186203f06a946fa0276ba54029"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:c04a46716adde8d927adb9457bbe39cf473e1e2c2f5d0a16ceb837e5d841ad4f"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:aaf63899c94de41fe3cf934601b0f7ccb6b428c6e4eeb80da72c58eab077b19a"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:d62e51710986674142526ab9f78663ca2b0726066ae26b78b22e0f5e571238dd"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-win32.whl", hash = "sha256:04e57ab9fbf9607b77f7d057974694b4f6b142da9ed4a199859d9d4d5c63fe96"}, - {file = "charset_normalizer-3.2.0-cp310-cp310-win_amd64.whl", hash = "sha256:48021783bdf96e3d6de03a6e39a1171ed5bd7e8bb93fc84cc649d11490f87cea"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:4957669ef390f0e6719db3613ab3a7631e68424604a7b448f079bee145da6e09"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:46fb8c61d794b78ec7134a715a3e564aafc8f6b5e338417cb19fe9f57a5a9bf2"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f779d3ad205f108d14e99bb3859aa7dd8e9c68874617c72354d7ecaec2a054ac"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f25c229a6ba38a35ae6e25ca1264621cc25d4d38dca2942a7fce0b67a4efe918"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2efb1bd13885392adfda4614c33d3b68dee4921fd0ac1d3988f8cbb7d589e72a"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f30b48dd7fa1474554b0b0f3fdfdd4c13b5c737a3c6284d3cdc424ec0ffff3a"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:246de67b99b6851627d945db38147d1b209a899311b1305dd84916f2b88526c6"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9bd9b3b31adcb054116447ea22caa61a285d92e94d710aa5ec97992ff5eb7cf3"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:8c2f5e83493748286002f9369f3e6607c565a6a90425a3a1fef5ae32a36d749d"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:3170c9399da12c9dc66366e9d14da8bf7147e1e9d9ea566067bbce7bb74bd9c2"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:7a4826ad2bd6b07ca615c74ab91f32f6c96d08f6fcc3902ceeedaec8cdc3bcd6"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:3b1613dd5aee995ec6d4c69f00378bbd07614702a315a2cf6c1d21461fe17c23"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:9e608aafdb55eb9f255034709e20d5a83b6d60c054df0802fa9c9883d0a937aa"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-win32.whl", hash = "sha256:f2a1d0fd4242bd8643ce6f98927cf9c04540af6efa92323e9d3124f57727bfc1"}, - {file = "charset_normalizer-3.2.0-cp311-cp311-win_amd64.whl", hash = "sha256:681eb3d7e02e3c3655d1b16059fbfb605ac464c834a0c629048a30fad2b27489"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:c57921cda3a80d0f2b8aec7e25c8aa14479ea92b5b51b6876d975d925a2ea346"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:41b25eaa7d15909cf3ac4c96088c1f266a9a93ec44f87f1d13d4a0e86c81b982"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f058f6963fd82eb143c692cecdc89e075fa0828db2e5b291070485390b2f1c9c"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a7647ebdfb9682b7bb97e2a5e7cb6ae735b1c25008a70b906aecca294ee96cf4"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:eef9df1eefada2c09a5e7a40991b9fc6ac6ef20b1372abd48d2794a316dc0449"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e03b8895a6990c9ab2cdcd0f2fe44088ca1c65ae592b8f795c3294af00a461c3"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:ee4006268ed33370957f55bf2e6f4d263eaf4dc3cfc473d1d90baff6ed36ce4a"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:c4983bf937209c57240cff65906b18bb35e64ae872da6a0db937d7b4af845dd7"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:3bb7fda7260735efe66d5107fb7e6af6a7c04c7fce9b2514e04b7a74b06bf5dd"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:72814c01533f51d68702802d74f77ea026b5ec52793c791e2da806a3844a46c3"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:70c610f6cbe4b9fce272c407dd9d07e33e6bf7b4aa1b7ffb6f6ded8e634e3592"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-win32.whl", hash = "sha256:a401b4598e5d3f4a9a811f3daf42ee2291790c7f9d74b18d75d6e21dda98a1a1"}, - {file = "charset_normalizer-3.2.0-cp37-cp37m-win_amd64.whl", hash = "sha256:c0b21078a4b56965e2b12f247467b234734491897e99c1d51cee628da9786959"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:95eb302ff792e12aba9a8b8f8474ab229a83c103d74a750ec0bd1c1eea32e669"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1a100c6d595a7f316f1b6f01d20815d916e75ff98c27a01ae817439ea7726329"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:6339d047dab2780cc6220f46306628e04d9750f02f983ddb37439ca47ced7149"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e4b749b9cc6ee664a3300bb3a273c1ca8068c46be705b6c31cf5d276f8628a94"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a38856a971c602f98472050165cea2cdc97709240373041b69030be15047691f"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f87f746ee241d30d6ed93969de31e5ffd09a2961a051e60ae6bddde9ec3583aa"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:89f1b185a01fe560bc8ae5f619e924407efca2191b56ce749ec84982fc59a32a"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e1c8a2f4c69e08e89632defbfabec2feb8a8d99edc9f89ce33c4b9e36ab63037"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2f4ac36d8e2b4cc1aa71df3dd84ff8efbe3bfb97ac41242fbcfc053c67434f46"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a386ebe437176aab38c041de1260cd3ea459c6ce5263594399880bbc398225b2"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:ccd16eb18a849fd8dcb23e23380e2f0a354e8daa0c984b8a732d9cfaba3a776d"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:e6a5bf2cba5ae1bb80b154ed68a3cfa2fa00fde979a7f50d6598d3e17d9ac20c"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:45de3f87179c1823e6d9e32156fb14c1927fcc9aba21433f088fdfb555b77c10"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-win32.whl", hash = "sha256:1000fba1057b92a65daec275aec30586c3de2401ccdcd41f8a5c1e2c87078706"}, - {file = "charset_normalizer-3.2.0-cp38-cp38-win_amd64.whl", hash = "sha256:8b2c760cfc7042b27ebdb4a43a4453bd829a5742503599144d54a032c5dc7e9e"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:855eafa5d5a2034b4621c74925d89c5efef61418570e5ef9b37717d9c796419c"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:203f0c8871d5a7987be20c72442488a0b8cfd0f43b7973771640fc593f56321f"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:e857a2232ba53ae940d3456f7533ce6ca98b81917d47adc3c7fd55dad8fab858"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5e86d77b090dbddbe78867a0275cb4df08ea195e660f1f7f13435a4649e954e5"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c4fb39a81950ec280984b3a44f5bd12819953dc5fa3a7e6fa7a80db5ee853952"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2dee8e57f052ef5353cf608e0b4c871aee320dd1b87d351c28764fc0ca55f9f4"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8700f06d0ce6f128de3ccdbc1acaea1ee264d2caa9ca05daaf492fde7c2a7200"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1920d4ff15ce893210c1f0c0e9d19bfbecb7983c76b33f046c13a8ffbd570252"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:c1c76a1743432b4b60ab3358c937a3fe1341c828ae6194108a94c69028247f22"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:f7560358a6811e52e9c4d142d497f1a6e10103d3a6881f18d04dbce3729c0e2c"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:c8063cf17b19661471ecbdb3df1c84f24ad2e389e326ccaf89e3fb2484d8dd7e"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:cd6dbe0238f7743d0efe563ab46294f54f9bc8f4b9bcf57c3c666cc5bc9d1299"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:1249cbbf3d3b04902ff081ffbb33ce3377fa6e4c7356f759f3cd076cc138d020"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-win32.whl", hash = "sha256:6c409c0deba34f147f77efaa67b8e4bb83d2f11c8806405f76397ae5b8c0d1c9"}, - {file = "charset_normalizer-3.2.0-cp39-cp39-win_amd64.whl", hash = "sha256:7095f6fbfaa55defb6b733cfeb14efaae7a29f0b59d8cf213be4e7ca0b857b80"}, - {file = "charset_normalizer-3.2.0-py3-none-any.whl", hash = "sha256:8e098148dd37b4ce3baca71fb394c81dc5d9c7728c95df695d2dca218edf40e6"}, + {file = "charset-normalizer-3.3.0.tar.gz", hash = "sha256:63563193aec44bce707e0c5ca64ff69fa72ed7cf34ce6e11d5127555756fd2f6"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:effe5406c9bd748a871dbcaf3ac69167c38d72db8c9baf3ff954c344f31c4cbe"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:4162918ef3098851fcd8a628bf9b6a98d10c380725df9e04caf5ca6dd48c847a"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:0570d21da019941634a531444364f2482e8db0b3425fcd5ac0c36565a64142c8"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5707a746c6083a3a74b46b3a631d78d129edab06195a92a8ece755aac25a3f3d"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:278c296c6f96fa686d74eb449ea1697f3c03dc28b75f873b65b5201806346a69"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a4b71f4d1765639372a3b32d2638197f5cd5221b19531f9245fcc9ee62d38f56"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f5969baeaea61c97efa706b9b107dcba02784b1601c74ac84f2a532ea079403e"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a3f93dab657839dfa61025056606600a11d0b696d79386f974e459a3fbc568ec"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:db756e48f9c5c607b5e33dd36b1d5872d0422e960145b08ab0ec7fd420e9d649"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:232ac332403e37e4a03d209a3f92ed9071f7d3dbda70e2a5e9cff1c4ba9f0678"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:e5c1502d4ace69a179305abb3f0bb6141cbe4714bc9b31d427329a95acfc8bdd"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:2502dd2a736c879c0f0d3e2161e74d9907231e25d35794584b1ca5284e43f596"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:23e8565ab7ff33218530bc817922fae827420f143479b753104ab801145b1d5b"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-win32.whl", hash = "sha256:1872d01ac8c618a8da634e232f24793883d6e456a66593135aeafe3784b0848d"}, + {file = "charset_normalizer-3.3.0-cp310-cp310-win_amd64.whl", hash = "sha256:557b21a44ceac6c6b9773bc65aa1b4cc3e248a5ad2f5b914b91579a32e22204d"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:d7eff0f27edc5afa9e405f7165f85a6d782d308f3b6b9d96016c010597958e63"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6a685067d05e46641d5d1623d7c7fdf15a357546cbb2f71b0ebde91b175ffc3e"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:0d3d5b7db9ed8a2b11a774db2bbea7ba1884430a205dbd54a32d61d7c2a190fa"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2935ffc78db9645cb2086c2f8f4cfd23d9b73cc0dc80334bc30aac6f03f68f8c"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9fe359b2e3a7729010060fbca442ca225280c16e923b37db0e955ac2a2b72a05"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:380c4bde80bce25c6e4f77b19386f5ec9db230df9f2f2ac1e5ad7af2caa70459"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f0d1e3732768fecb052d90d62b220af62ead5748ac51ef61e7b32c266cac9293"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1b2919306936ac6efb3aed1fbf81039f7087ddadb3160882a57ee2ff74fd2382"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:f8888e31e3a85943743f8fc15e71536bda1c81d5aa36d014a3c0c44481d7db6e"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:82eb849f085624f6a607538ee7b83a6d8126df6d2f7d3b319cb837b289123078"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:7b8b8bf1189b3ba9b8de5c8db4d541b406611a71a955bbbd7385bbc45fcb786c"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:5adf257bd58c1b8632046bbe43ee38c04e1038e9d37de9c57a94d6bd6ce5da34"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:c350354efb159b8767a6244c166f66e67506e06c8924ed74669b2c70bc8735b1"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-win32.whl", hash = "sha256:02af06682e3590ab952599fbadac535ede5d60d78848e555aa58d0c0abbde786"}, + {file = "charset_normalizer-3.3.0-cp311-cp311-win_amd64.whl", hash = "sha256:86d1f65ac145e2c9ed71d8ffb1905e9bba3a91ae29ba55b4c46ae6fc31d7c0d4"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:3b447982ad46348c02cb90d230b75ac34e9886273df3a93eec0539308a6296d7"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:abf0d9f45ea5fb95051c8bfe43cb40cda383772f7e5023a83cc481ca2604d74e"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:b09719a17a2301178fac4470d54b1680b18a5048b481cb8890e1ef820cb80455"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b3d9b48ee6e3967b7901c052b670c7dda6deb812c309439adaffdec55c6d7b78"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:edfe077ab09442d4ef3c52cb1f9dab89bff02f4524afc0acf2d46be17dc479f5"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3debd1150027933210c2fc321527c2299118aa929c2f5a0a80ab6953e3bd1908"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:86f63face3a527284f7bb8a9d4f78988e3c06823f7bea2bd6f0e0e9298ca0403"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:24817cb02cbef7cd499f7c9a2735286b4782bd47a5b3516a0e84c50eab44b98e"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:c71f16da1ed8949774ef79f4a0260d28b83b3a50c6576f8f4f0288d109777989"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:9cf3126b85822c4e53aa28c7ec9869b924d6fcfb76e77a45c44b83d91afd74f9"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:b3b2316b25644b23b54a6f6401074cebcecd1244c0b8e80111c9a3f1c8e83d65"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:03680bb39035fbcffe828eae9c3f8afc0428c91d38e7d61aa992ef7a59fb120e"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:4cc152c5dd831641e995764f9f0b6589519f6f5123258ccaca8c6d34572fefa8"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-win32.whl", hash = "sha256:b8f3307af845803fb0b060ab76cf6dd3a13adc15b6b451f54281d25911eb92df"}, + {file = "charset_normalizer-3.3.0-cp312-cp312-win_amd64.whl", hash = "sha256:8eaf82f0eccd1505cf39a45a6bd0a8cf1c70dcfc30dba338207a969d91b965c0"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:dc45229747b67ffc441b3de2f3ae5e62877a282ea828a5bdb67883c4ee4a8810"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2f4a0033ce9a76e391542c182f0d48d084855b5fcba5010f707c8e8c34663d77"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ada214c6fa40f8d800e575de6b91a40d0548139e5dc457d2ebb61470abf50186"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b1121de0e9d6e6ca08289583d7491e7fcb18a439305b34a30b20d8215922d43c"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1063da2c85b95f2d1a430f1c33b55c9c17ffaf5e612e10aeaad641c55a9e2b9d"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:70f1d09c0d7748b73290b29219e854b3207aea922f839437870d8cc2168e31cc"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:250c9eb0f4600361dd80d46112213dff2286231d92d3e52af1e5a6083d10cad9"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:750b446b2ffce1739e8578576092179160f6d26bd5e23eb1789c4d64d5af7dc7"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:fc52b79d83a3fe3a360902d3f5d79073a993597d48114c29485e9431092905d8"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:588245972aca710b5b68802c8cad9edaa98589b1b42ad2b53accd6910dad3545"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:e39c7eb31e3f5b1f88caff88bcff1b7f8334975b46f6ac6e9fc725d829bc35d4"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-win32.whl", hash = "sha256:abecce40dfebbfa6abf8e324e1860092eeca6f7375c8c4e655a8afb61af58f2c"}, + {file = "charset_normalizer-3.3.0-cp37-cp37m-win_amd64.whl", hash = "sha256:24a91a981f185721542a0b7c92e9054b7ab4fea0508a795846bc5b0abf8118d4"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:67b8cc9574bb518ec76dc8e705d4c39ae78bb96237cb533edac149352c1f39fe"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:ac71b2977fb90c35d41c9453116e283fac47bb9096ad917b8819ca8b943abecd"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:3ae38d325b512f63f8da31f826e6cb6c367336f95e418137286ba362925c877e"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:542da1178c1c6af8873e143910e2269add130a299c9106eef2594e15dae5e482"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:30a85aed0b864ac88309b7d94be09f6046c834ef60762a8833b660139cfbad13"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:aae32c93e0f64469f74ccc730a7cb21c7610af3a775157e50bbd38f816536b38"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:15b26ddf78d57f1d143bdf32e820fd8935d36abe8a25eb9ec0b5a71c82eb3895"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7f5d10bae5d78e4551b7be7a9b29643a95aded9d0f602aa2ba584f0388e7a557"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:249c6470a2b60935bafd1d1d13cd613f8cd8388d53461c67397ee6a0f5dce741"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:c5a74c359b2d47d26cdbbc7845e9662d6b08a1e915eb015d044729e92e7050b7"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:b5bcf60a228acae568e9911f410f9d9e0d43197d030ae5799e20dca8df588287"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:187d18082694a29005ba2944c882344b6748d5be69e3a89bf3cc9d878e548d5a"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:81bf654678e575403736b85ba3a7867e31c2c30a69bc57fe88e3ace52fb17b89"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-win32.whl", hash = "sha256:85a32721ddde63c9df9ebb0d2045b9691d9750cb139c161c80e500d210f5e26e"}, + {file = "charset_normalizer-3.3.0-cp38-cp38-win_amd64.whl", hash = "sha256:468d2a840567b13a590e67dd276c570f8de00ed767ecc611994c301d0f8c014f"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:e0fc42822278451bc13a2e8626cf2218ba570f27856b536e00cfa53099724828"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:09c77f964f351a7369cc343911e0df63e762e42bac24cd7d18525961c81754f4"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:12ebea541c44fdc88ccb794a13fe861cc5e35d64ed689513a5c03d05b53b7c82"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:805dfea4ca10411a5296bcc75638017215a93ffb584c9e344731eef0dcfb026a"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:96c2b49eb6a72c0e4991d62406e365d87067ca14c1a729a870d22354e6f68115"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:aaf7b34c5bc56b38c931a54f7952f1ff0ae77a2e82496583b247f7c969eb1479"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:619d1c96099be5823db34fe89e2582b336b5b074a7f47f819d6b3a57ff7bdb86"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a0ac5e7015a5920cfce654c06618ec40c33e12801711da6b4258af59a8eff00a"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:93aa7eef6ee71c629b51ef873991d6911b906d7312c6e8e99790c0f33c576f89"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:7966951325782121e67c81299a031f4c115615e68046f79b85856b86ebffc4cd"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:02673e456dc5ab13659f85196c534dc596d4ef260e4d86e856c3b2773ce09843"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:c2af80fb58f0f24b3f3adcb9148e6203fa67dd3f61c4af146ecad033024dde43"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:153e7b6e724761741e0974fc4dcd406d35ba70b92bfe3fedcb497226c93b9da7"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-win32.whl", hash = "sha256:d47ecf253780c90ee181d4d871cd655a789da937454045b17b5798da9393901a"}, + {file = "charset_normalizer-3.3.0-cp39-cp39-win_amd64.whl", hash = "sha256:d97d85fa63f315a8bdaba2af9a6a686e0eceab77b3089af45133252618e70884"}, + {file = "charset_normalizer-3.3.0-py3-none-any.whl", hash = "sha256:e46cd37076971c1040fc8c41273a8b3e2c624ce4f2be3f5dfcb7a430c1d3acc2"}, ] [[package]] @@ -280,7 +298,6 @@ category = "dev" optional = false python-versions = "*" files = [ - {file = "livereload-2.6.3-py2.py3-none-any.whl", hash = "sha256:ad4ac6f53b2d62bb6ce1a5e6e96f1f00976a32348afedcb4b6d68df2a1d346e4"}, {file = "livereload-2.6.3.tar.gz", hash = "sha256:776f2f865e59fde56490a56bcc6773b6917366bce0c267c60ee8aaf1a0959869"}, ] @@ -350,14 +367,14 @@ files = [ [[package]] name = "packaging" -version = "23.1" +version = "23.2" description = "Core utilities for Python packages" category = "main" optional = false python-versions = ">=3.7" files = [ - {file = "packaging-23.1-py3-none-any.whl", hash = "sha256:994793af429502c4ea2ebf6bf664629d07c1a9fe974af92966e4b8d2df7edc61"}, - {file = "packaging-23.1.tar.gz", hash = "sha256:a392980d2b6cffa644431898be54b0045151319d1e7ec34f0cfed48767dd334f"}, + {file = "packaging-23.2-py3-none-any.whl", hash = "sha256:8c491190033a9af7e1d931d0b5dacc2ef47509b34dd0de67ed209b5203fc88c7"}, + {file = "packaging-23.2.tar.gz", hash = "sha256:048fb0e9405036518eaaf48a55953c750c11e1a1b68e0dd1a9d62ed0c092cfc5"}, ] [[package]] @@ -396,14 +413,14 @@ plugins = ["importlib-metadata"] [[package]] name = "pytest" -version = "7.4.0" +version = "7.4.2" description = "pytest: simple powerful testing with Python" category = "dev" optional = false python-versions = ">=3.7" files = [ - {file = "pytest-7.4.0-py3-none-any.whl", hash = "sha256:78bf16451a2eb8c7a2ea98e32dc119fd2aa758f1d5d66dbf0a59d69a3969df32"}, - {file = "pytest-7.4.0.tar.gz", hash = "sha256:b4bf8c45bd59934ed84001ad51e11b4ee40d40a1229d2c79f9c592b0a3f6bd8a"}, + {file = "pytest-7.4.2-py3-none-any.whl", hash = "sha256:1d881c6124e08ff0a1bb75ba3ec0bfd8b5354a01c194ddd5a0a870a48d99b002"}, + {file = "pytest-7.4.2.tar.gz", hash = "sha256:a766259cfab564a2ad52cb1aae1b881a75c3eb7e34ca3779697c23ed47c47069"}, ] [package.dependencies] @@ -420,14 +437,14 @@ testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "no [[package]] name = "pytz" -version = "2023.3" +version = "2023.3.post1" description = "World timezone definitions, modern and historical" category = "main" optional = false python-versions = "*" files = [ - {file = "pytz-2023.3-py2.py3-none-any.whl", hash = "sha256:a151b3abb88eda1d4e34a9814df37de2a80e301e68ba0fd856fb9b46bfbbbffb"}, - {file = "pytz-2023.3.tar.gz", hash = "sha256:1d8ce29db189191fb55338ee6d0387d82ab59f3d00eac103412d64e0ebd0c588"}, + {file = "pytz-2023.3.post1-py2.py3-none-any.whl", hash = "sha256:ce42d816b81b68506614c11e8937d3aa9e41007ceb50bfdcb0749b921bf646c7"}, + {file = "pytz-2023.3.post1.tar.gz", hash = "sha256:7b4fddbeb94a1eba4b557da24f19fdf9db575192544270a9101d8509f9f43d7b"}, ] [[package]] @@ -858,14 +875,14 @@ test = ["pytest"] [[package]] name = "sphinxcontrib-youtube" -version = "1.2.0" -description = "Sphinx \"youtube\" extension" +version = "1.3.0" +description = "Sphinx \"youtube\" extension." category = "main" optional = false python-versions = "*" files = [ - {file = "sphinxcontrib-youtube-1.2.0.tar.gz", hash = "sha256:f468b76550e926c6d918c97b921d6ccc8ec6bc13004746dea309788ea9268991"}, - {file = "sphinxcontrib_youtube-1.2.0-py3-none-any.whl", hash = "sha256:fcc9301b5df3269597310c1ab41806b25fb7bfe41b0344aa8871dbd820d08ca4"}, + {file = "sphinxcontrib-youtube-1.3.0.tar.gz", hash = "sha256:c3869eff5f62406a877a0cd6f6d535eee710a0521ea6791443d99b2f0711c02a"}, + {file = "sphinxcontrib_youtube-1.3.0-py2.py3-none-any.whl", hash = "sha256:6757179ee710800fcc434b97da57000ee8604e7f0b8dd4cea268988be8f33b28"}, ] [package.dependencies] @@ -873,7 +890,9 @@ requests = "*" Sphinx = ">=0.6" [package.extras] -doc = ["furo", "sphinx-copybutton"] +dev = ["nox"] +doc = ["pydata-sphinx-theme", "sphinx-copybutton", "sphinx-design"] +test = ["beautifulsoup4", "pytest", "pytest-cov", "pytest-regressions"] [[package]] name = "tomli" @@ -889,12 +908,24 @@ files = [ [[package]] name = "tornado" -version = "6.3.3" +version = "6.2" description = "Tornado is a Python web framework and asynchronous networking library, originally developed at FriendFeed." category = "dev" optional = false python-versions = ">= 3.7" -files = [] +files = [ + {file = "tornado-6.2-cp37-abi3-macosx_10_9_universal2.whl", hash = "sha256:20f638fd8cc85f3cbae3c732326e96addff0a15e22d80f049e00121651e82e72"}, + {file = "tornado-6.2-cp37-abi3-macosx_10_9_x86_64.whl", hash = "sha256:87dcafae3e884462f90c90ecc200defe5e580a7fbbb4365eda7c7c1eb809ebc9"}, + {file = "tornado-6.2-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ba09ef14ca9893954244fd872798b4ccb2367c165946ce2dd7376aebdde8e3ac"}, + {file = "tornado-6.2-cp37-abi3-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b8150f721c101abdef99073bf66d3903e292d851bee51910839831caba341a75"}, + {file = "tornado-6.2-cp37-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d3a2f5999215a3a06a4fc218026cd84c61b8b2b40ac5296a6db1f1451ef04c1e"}, + {file = "tornado-6.2-cp37-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:5f8c52d219d4995388119af7ccaa0bcec289535747620116a58d830e7c25d8a8"}, + {file = "tornado-6.2-cp37-abi3-musllinux_1_1_i686.whl", hash = "sha256:6fdfabffd8dfcb6cf887428849d30cf19a3ea34c2c248461e1f7d718ad30b66b"}, + {file = "tornado-6.2-cp37-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:1d54d13ab8414ed44de07efecb97d4ef7c39f7438cf5e976ccd356bebb1b5fca"}, + {file = "tornado-6.2-cp37-abi3-win32.whl", hash = "sha256:5c87076709343557ef8032934ce5f637dbb552efa7b21d08e89ae7619ed0eb23"}, + {file = "tornado-6.2-cp37-abi3-win_amd64.whl", hash = "sha256:e5f923aa6a47e133d1cf87d60700889d7eae68988704e20c75fb2d65677a8e4b"}, + {file = "tornado-6.2.tar.gz", hash = "sha256:9b630419bde84ec666bfd7ea0a4cb2a8a651c2d5cccdbdd1972a0c859dfc3c13"}, +] [[package]] name = "typing-extensions" @@ -910,14 +941,14 @@ files = [ [[package]] name = "urllib3" -version = "2.0.4" +version = "2.0.6" description = "HTTP library with thread-safe connection pooling, file post, and more." category = "main" optional = false python-versions = ">=3.7" files = [ - {file = "urllib3-2.0.4-py3-none-any.whl", hash = "sha256:de7df1803967d2c2a98e4b11bb7d6bd9210474c46e8a0401514e3a42a75ebde4"}, - {file = "urllib3-2.0.4.tar.gz", hash = "sha256:8d22f86aae8ef5e410d4f539fde9ce6b2113a001bb4d189e0aed70642d602b11"}, + {file = "urllib3-2.0.6-py3-none-any.whl", hash = "sha256:7a7c7003b000adf9e7ca2a377c9688bbc54ed41b985789ed576570342a375cd2"}, + {file = "urllib3-2.0.6.tar.gz", hash = "sha256:b19e1a85d206b56d7df1d5e683df4a7725252a964e3993648dd0fb5a1c157564"}, ] [package.extras] diff --git a/site/source/_static/images/config/physical-backup1.png b/site/source/_static/images/config/physical-backup1.png deleted file mode 100644 index cf1034b..0000000 Binary files a/site/source/_static/images/config/physical-backup1.png and /dev/null differ diff --git a/nextcloud-mac-tor.png b/site/source/_static/images/nextcloud/nextcloud-mac-tor.png similarity index 100% rename from nextcloud-mac-tor.png rename to site/source/_static/images/nextcloud/nextcloud-mac-tor.png diff --git a/site/source/_static/images/restore/recover0.png b/site/source/_static/images/restore/recover0.png index 2538213..5526138 100644 Binary files a/site/source/_static/images/restore/recover0.png and b/site/source/_static/images/restore/recover0.png differ diff --git a/site/source/_static/images/restore/recover4.png b/site/source/_static/images/restore/recover4.png index 4c26dd7..8f49bd2 100644 Binary files a/site/source/_static/images/restore/recover4.png and b/site/source/_static/images/restore/recover4.png differ diff --git a/site/source/_static/images/restore/recover5.png b/site/source/_static/images/restore/recover5.png index c92178f..c21c70c 100644 Binary files a/site/source/_static/images/restore/recover5.png and b/site/source/_static/images/restore/recover5.png differ diff --git a/site/source/_static/images/restore/recover6.png b/site/source/_static/images/restore/recover6.png index 54593ad..094f7ab 100644 Binary files a/site/source/_static/images/restore/recover6.png and b/site/source/_static/images/restore/recover6.png differ diff --git a/site/source/_static/images/setup/pw_reset-s4-importing_drive.jpg b/site/source/_static/images/setup/pw_reset-s4-importing_drive.jpg deleted file mode 100644 index 9d5ebd1..0000000 Binary files a/site/source/_static/images/setup/pw_reset-s4-importing_drive.jpg and /dev/null differ diff --git a/site/source/_static/images/setup/pw_reset-s6-reset_complete.jpg b/site/source/_static/images/setup/pw_reset-s6-reset_complete.jpg deleted file mode 100644 index 7fc9634..0000000 Binary files a/site/source/_static/images/setup/pw_reset-s6-reset_complete.jpg and /dev/null differ diff --git a/site/source/_static/images/setup/screen0-recover.jpg b/site/source/_static/images/setup/screen0-recover.jpg new file mode 100644 index 0000000..fa30395 Binary files /dev/null and b/site/source/_static/images/setup/screen0-recover.jpg differ diff --git a/site/source/_static/images/setup/screen0-startfresh_or_recover.jpg b/site/source/_static/images/setup/screen0-startfresh_or_recover.jpg index b107025..64cdde0 100644 Binary files a/site/source/_static/images/setup/screen0-startfresh_or_recover.jpg and b/site/source/_static/images/setup/screen0-startfresh_or_recover.jpg differ diff --git a/site/source/_static/images/setup/screen0-startfresh_or_recover.png b/site/source/_static/images/setup/screen0-startfresh_or_recover.png deleted file mode 100644 index 9099bc1..0000000 Binary files a/site/source/_static/images/setup/screen0-startfresh_or_recover.png and /dev/null differ diff --git a/site/source/_static/images/setup/screen1-restore_or_useexisting.jpg b/site/source/_static/images/setup/screen1-restore_or_useexisting.jpg deleted file mode 100644 index 5c692b1..0000000 Binary files a/site/source/_static/images/setup/screen1-restore_or_useexisting.jpg and /dev/null differ diff --git a/site/source/_static/images/setup/screen2-select_storage.jpg b/site/source/_static/images/setup/screen2-select_storage.jpg new file mode 100644 index 0000000..f0008f9 Binary files /dev/null and b/site/source/_static/images/setup/screen2-select_storage.jpg differ diff --git a/site/source/_static/images/setup/screen3-restore_drive.jpg b/site/source/_static/images/setup/screen3-restore_drive.jpg deleted file mode 100644 index e3bf448..0000000 Binary files a/site/source/_static/images/setup/screen3-restore_drive.jpg and /dev/null differ diff --git a/site/source/_static/images/setup/screen3-use_existing.jpg b/site/source/_static/images/setup/screen3-use_existing.jpg index f5f9902..3f1fd4f 100644 Binary files a/site/source/_static/images/setup/screen3-use_existing.jpg and b/site/source/_static/images/setup/screen3-use_existing.jpg differ diff --git a/site/source/_static/images/setup/screen3-use_existing.png b/site/source/_static/images/setup/screen3-use_existing.png deleted file mode 100644 index 75b7a76..0000000 Binary files a/site/source/_static/images/setup/screen3-use_existing.png and /dev/null differ diff --git a/site/source/_static/images/setup/screen4-select_storage.jpg b/site/source/_static/images/setup/screen4-select_storage.jpg deleted file mode 100644 index df5b377..0000000 Binary files a/site/source/_static/images/setup/screen4-select_storage.jpg and /dev/null differ diff --git a/site/source/_static/images/setup/screen4-use_existing_drive_selection.jpg b/site/source/_static/images/setup/screen4-use_existing_drive_selection.jpg new file mode 100644 index 0000000..4dd8fe5 Binary files /dev/null and b/site/source/_static/images/setup/screen4-use_existing_drive_selection.jpg differ diff --git a/site/source/_static/images/setup/screen4-use_existing_drive_selection.png b/site/source/_static/images/setup/screen4-use_existing_drive_selection.png deleted file mode 100644 index 82b60be..0000000 Binary files a/site/source/_static/images/setup/screen4-use_existing_drive_selection.png and /dev/null differ diff --git a/site/source/_static/images/setup/screen5-set_password.jpg b/site/source/_static/images/setup/screen5-set_password.jpg deleted file mode 100644 index 7d1a3ad..0000000 Binary files a/site/source/_static/images/setup/screen5-set_password.jpg and /dev/null differ diff --git a/site/source/_static/images/setup/screen5-set_password_complete.jpg b/site/source/_static/images/setup/screen5-set_password_complete.jpg new file mode 100644 index 0000000..7d7dce0 Binary files /dev/null and b/site/source/_static/images/setup/screen5-set_password_complete.jpg differ diff --git a/site/source/_static/images/setup/screen6-storage_initialize.jpg b/site/source/_static/images/setup/screen6-storage_initialize.jpg index e9e1cc0..f978bc0 100644 Binary files a/site/source/_static/images/setup/screen6-storage_initialize.jpg and b/site/source/_static/images/setup/screen6-storage_initialize.jpg differ diff --git a/site/source/_static/images/setup/screen7-startfresh_complete.jpg b/site/source/_static/images/setup/screen7-startfresh_complete.jpg index 5a1f07d..0c08411 100644 Binary files a/site/source/_static/images/setup/screen7-startfresh_complete.jpg and b/site/source/_static/images/setup/screen7-startfresh_complete.jpg differ diff --git a/site/source/_static/images/setup/screen7-upgrade_complete.jpg b/site/source/_static/images/setup/screen7-upgrade_complete.jpg deleted file mode 100644 index e0e1290..0000000 Binary files a/site/source/_static/images/setup/screen7-upgrade_complete.jpg and /dev/null differ diff --git a/site/source/_static/images/setup/screen9-startfresh_complete-savedfile-go_to_login.jpg b/site/source/_static/images/setup/screen9-startfresh_complete-savedfile-go_to_login.jpg deleted file mode 100644 index 9fd98ff..0000000 Binary files a/site/source/_static/images/setup/screen9-startfresh_complete-savedfile-go_to_login.jpg and /dev/null differ diff --git a/site/source/_static/images/setup/screen9-startfresh_complete-savedfile-go_to_start_login.jpg b/site/source/_static/images/setup/screen9-startfresh_complete-savedfile-go_to_start_login.jpg deleted file mode 100644 index 9fd98ff..0000000 Binary files a/site/source/_static/images/setup/screen9-startfresh_complete-savedfile-go_to_start_login.jpg and /dev/null differ diff --git a/site/source/_static/images/setup/screen9-startfresh_complete_saved.jpg b/site/source/_static/images/setup/screen9-startfresh_complete_saved.jpg new file mode 100644 index 0000000..c8f1119 Binary files /dev/null and b/site/source/_static/images/setup/screen9-startfresh_complete_saved.jpg differ diff --git a/site/source/_static/images/setup/setup0.png b/site/source/_static/images/setup/setup0.png deleted file mode 100644 index b9e1c3c..0000000 Binary files a/site/source/_static/images/setup/setup0.png and /dev/null differ diff --git a/site/source/_static/images/setup/setup1.png b/site/source/_static/images/setup/setup1.png deleted file mode 100644 index ed307ab..0000000 Binary files a/site/source/_static/images/setup/setup1.png and /dev/null differ diff --git a/site/source/_static/images/setup/setup2.png b/site/source/_static/images/setup/setup2.png deleted file mode 100644 index 163d78a..0000000 Binary files a/site/source/_static/images/setup/setup2.png and /dev/null differ diff --git a/site/source/_static/images/setup/setup3.png b/site/source/_static/images/setup/setup3.png deleted file mode 100644 index 0ad6b82..0000000 Binary files a/site/source/_static/images/setup/setup3.png and /dev/null differ diff --git a/site/source/_static/images/setup/setup4.png b/site/source/_static/images/setup/setup4.png deleted file mode 100644 index 2543030..0000000 Binary files a/site/source/_static/images/setup/setup4.png and /dev/null differ diff --git a/site/source/_static/images/setup/setup5.png b/site/source/_static/images/setup/setup5.png deleted file mode 100644 index b4797d3..0000000 Binary files a/site/source/_static/images/setup/setup5.png and /dev/null differ diff --git a/site/source/_static/images/setup/setup_complete_pre_download.png b/site/source/_static/images/setup/setup_complete_pre_download.png deleted file mode 100644 index e555c45..0000000 Binary files a/site/source/_static/images/setup/setup_complete_pre_download.png and /dev/null differ diff --git a/site/source/_static/images/setup/transfer-from.png b/site/source/_static/images/setup/transfer-from.png index 7da3f1b..7f28f58 100644 Binary files a/site/source/_static/images/setup/transfer-from.png and b/site/source/_static/images/setup/transfer-from.png differ diff --git a/site/source/_static/images/setup/transfer-to.png b/site/source/_static/images/setup/transfer-to.png index 702ca85..6d12b47 100644 Binary files a/site/source/_static/images/setup/transfer-to.png and b/site/source/_static/images/setup/transfer-to.png differ diff --git a/site/source/_static/images/setup/transfer.png b/site/source/_static/images/setup/transfer.png index 31c78e5..79010cc 100644 Binary files a/site/source/_static/images/setup/transfer.png and b/site/source/_static/images/setup/transfer.png differ diff --git a/site/source/_static/images/setup/trust-ca-1.png b/site/source/_static/images/setup/trust-ca-1.png new file mode 100644 index 0000000..1d0d55d Binary files /dev/null and b/site/source/_static/images/setup/trust-ca-1.png differ diff --git a/site/source/_static/images/setup/trust-ca-2.png b/site/source/_static/images/setup/trust-ca-2.png new file mode 100644 index 0000000..18de8ff Binary files /dev/null and b/site/source/_static/images/setup/trust-ca-2.png differ diff --git a/site/source/_static/images/setup/trust-ca-3.png b/site/source/_static/images/setup/trust-ca-3.png new file mode 100644 index 0000000..6381b3c Binary files /dev/null and b/site/source/_static/images/setup/trust-ca-3.png differ diff --git a/site/source/_static/images/setup/trust-ca-4.png b/site/source/_static/images/setup/trust-ca-4.png new file mode 100644 index 0000000..40a843d Binary files /dev/null and b/site/source/_static/images/setup/trust-ca-4.png differ diff --git a/site/source/_static/images/setup/upgrade6.jpg b/site/source/_static/images/setup/upgrade6.jpg deleted file mode 100644 index e0e1290..0000000 Binary files a/site/source/_static/images/setup/upgrade6.jpg and /dev/null differ diff --git a/site/source/_static/images/setup/use-drive.png b/site/source/_static/images/setup/use-drive.png deleted file mode 100644 index f676c15..0000000 Binary files a/site/source/_static/images/setup/use-drive.png and /dev/null differ diff --git a/site/source/conf.py b/site/source/conf.py index 457cfa7..1a67e31 100644 --- a/site/source/conf.py +++ b/site/source/conf.py @@ -70,14 +70,15 @@ notfound_template = "404.html" TAGS = [] smv_tag_whitelist = multiversion_regex_builder(TAGS) # Whitelist pattern for branches (set to None to ignore all branches) -BRANCHES = ["0.2.x", "0.3.1.x", "0.3.2.x", "master"] +BRANCHES = ["0.3.4.x", "0.3.5.x"] smv_branch_whitelist = multiversion_regex_builder(BRANCHES) # Defines which version is considered to be the latest stable version. # Must be listed in smv_tag_whitelist or smv_branch_whitelist. -smv_latest_version = "master" -smv_rename_latest_version = "latest" +smv_latest_version = "0.3.5.x" +# smv_rename_latest_version = "0.3.5.x" # Whitelist pattern for remotes (set to None to use local branches only) smv_remote_whitelist = r"^origin$" +# smv_remote_whitelist = "none" # Pattern for released versions smv_released_pattern = r'^tags/.*$' # Format for versioned output directories inside the build directory diff --git a/site/source/getting-started/initial-setup.rst b/site/source/getting-started/initial-setup.rst index df65067..4618d4d 100644 --- a/site/source/getting-started/initial-setup.rst +++ b/site/source/getting-started/initial-setup.rst @@ -19,7 +19,7 @@ Follow the instructions below to set up your server for the first time. #. Select your storage drive. In most cases, there will be only one - .. figure:: /_static/images/setup/screen4-select_storage.jpg + .. figure:: /_static/images/setup/screen2-select_storage.jpg :width: 50% :alt: Select Drive @@ -27,7 +27,7 @@ Follow the instructions below to set up your server for the first time. .. warning:: Choose a strong master password. Write it down. Store it somewhere safe. DO NOT LOSE IT. - .. figure:: /_static/images/setup/screen5-set_password.jpg + .. figure:: /_static/images/setup/screen5-set_password_complete.jpg :width: 50% :alt: Create New Password @@ -47,10 +47,12 @@ Follow the instructions below to set up your server for the first time. #. Setup complete! Click ``Login to StartOS`` to access your new server - .. figure:: /_static/images/setup/screen9-startfresh_complete-savedfile-go_to_start_login.jpg + .. figure:: /_static/images/setup/screen9-startfresh_complete_saved.jpg :width: 50% :alt: Setup Complete +#. Now you will need to :ref:`trust your root CA` in order to login. + .. _setup-troubleshooting: Troubleshooting diff --git a/site/source/getting-started/trust-ca.rst b/site/source/getting-started/trust-ca.rst index 075b26c..40b2c00 100644 --- a/site/source/getting-started/trust-ca.rst +++ b/site/source/getting-started/trust-ca.rst @@ -6,8 +6,43 @@ Trusting Your Root CA Download and trust your server's Root Certificate Authority (Root CA) to enable encrypted communications locally and enhance speeds over Tor. -Download Your Server's Root CA +.. _trust-root-ca-on-initial-setup: + +Trust Root CA on Initial Setup ------------------------------ + +If you've just completed initial setup, you will automatically be prompted to trust your server's Root CA. Do these mandatory steps below: + + #. Click `DOWNLOAD`` to download your Root CA + + .. figure:: /_static/images/setup/trust-ca-1.png + :width: 40% + :alt: Download your Server's Root CA + + + #. You may see a dialog box noting it saved to your Downloads folder. Select :ref:`VIEW DOCS` to learn how to trust your server's Root CA on your device's operating system. + + .. figure:: /_static/images/setup/trust-ca-2.png + :width: 40% + :alt: + + #. The `Go To Login` panel will display "Waiting for trust..." until you have completed the process to install and trust your Root CA on your device. + + .. figure:: /_static/images/setup/trust-ca-3.png + :width: 40% + :alt: + + + #. Once you've successfully trusted your Root CA, you can login by selecting `OPEN`. + + .. figure:: /_static/images/setup/trust-ca-4.png + :width: 40% + :alt: + +.. _download-root-ca: + +Download Root CA +----------------- Your server's Root CA was included in the downloaded file at the end of initial setup. If you do not have that file, you can find your server's Root CA inside the StartOS dashboard. #. Navigate to `System > Root CA` and click `Download Certificate` @@ -16,10 +51,12 @@ Your server's Root CA was included in the downloaded file at the end of initial :width: 40% :alt: LAN setup menu item -Trust Your Server's Root CA ---------------------------- +.. _trust-your-root-ca: -Select your OS: +Trust Root CA +-------------- + +Select your operating system: .. raw:: html diff --git a/site/source/guides/device-guides/android/ca-android.rst b/site/source/guides/device-guides/android/ca-android.rst index 648e514..4ac23e5 100644 --- a/site/source/guides/device-guides/android/ca-android.rst +++ b/site/source/guides/device-guides/android/ca-android.rst @@ -7,7 +7,7 @@ Complete this guide to trust your server's Root Certificate Authority (Root CA) .. note:: This guide only applies to Android phones running Android v13+, as well as phones running CalyxOS, GrapheneOS, or LineageOS (v19+). -#. Ensure you have already `downloaded your server's Root CA `_ +#. Ensure you have already `downloaded your server's Root CA `_ #. Tap **Settings > Security > More security settings > Encryption & credentials > Install a certificate > CA Certificate > Install Anyway** and select your custom-named ``adjective-noun.local.crt`` certificate. diff --git a/site/source/guides/device-guides/index.rst b/site/source/guides/device-guides/index.rst index 4fbe96b..dfb4f54 100644 --- a/site/source/guides/device-guides/index.rst +++ b/site/source/guides/device-guides/index.rst @@ -56,6 +56,24 @@ Guides for integrating your client devices with your StartOS server. Guides for iOS +.. topic-box:: + :title: Synology + :icon: scylla-icon scylla-icon--cloud + :link: synology + :class: large-4 + :anchor: View + + Guides for Synology + +.. topic-box:: + :title: Truenas + :icon: scylla-icon scylla-icon--cloud + :link: truenas + :class: large-4 + :anchor: View + + Guides for Truenas + .. toctree:: :maxdepth: 2 :hidden: @@ -65,3 +83,5 @@ Guides for integrating your client devices with your StartOS server. windows/index android/index ios/index + synology/index + truenas/index diff --git a/site/source/guides/device-guides/ios/ca-ios.rst b/site/source/guides/device-guides/ios/ca-ios.rst index 123123c..767d303 100644 --- a/site/source/guides/device-guides/ios/ca-ios.rst +++ b/site/source/guides/device-guides/ios/ca-ios.rst @@ -7,7 +7,7 @@ Complete this guide to trust your server's Root Certificate Authority (Root CA) .. note:: This guide only applies to iOS v15+. For v14, see the `v14 guide `_. -#. Ensure you have already `downloaded your server's Root CA `_ +#. Ensure you have already `downloaded your server's Root CA `_ #. Open your iCloud Downloads folder and click on the certificate. It will display a dialog box that says "Profile Downloaded." Click `Close`. diff --git a/site/source/guides/device-guides/linux/ca-linux.rst b/site/source/guides/device-guides/linux/ca-linux.rst index bb44594..b445f9a 100644 --- a/site/source/guides/device-guides/linux/ca-linux.rst +++ b/site/source/guides/device-guides/linux/ca-linux.rst @@ -12,7 +12,7 @@ Trusting Your Server's Root CA on Linux These instructions will work for most Debian-based Linux distributions, such as Debian, Linux Mint, PopOS, Ubuntu, etc. - #. Ensure you have already `downloaded your server's Root CA `_ + #. Ensure you have already `downloaded your server's Root CA `_ #. Perform the following commands in the Terminal: @@ -37,21 +37,21 @@ Trusting Your Server's Root CA on Linux .. group-tab:: Arch/Garuda - #. Ensure you have already `downloaded your server's Root CA `_ + #. Ensure you have already `downloaded your server's Root CA `_ - #. From the folder you have downloaded your Start9 server's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here): + #. From the folder you have downloaded your Start9 server's Root CA, run the following commands. Take care to replace `adjective-noun` with your server's unique adjective-noun combination in the command below. If you have changed the certificate's filename, be sure to change it here. .. code-block:: bash sudo pacman -S ca-certificates - sudo cp ".crt" /etc/ca-certificates/trust-source/anchors/ + sudo cp "adjective-noun.local.crt" /etc/ca-certificates/trust-source/anchors/ sudo update-ca-trust Despite no output from the last command, you can test your app right away. .. group-tab:: CentOS/Fedora - #. Ensure you have already `downloaded your server's Root CA `_ + #. Ensure you have already `downloaded your server's Root CA `_ #. In `/etc/systemd/resolved.conf`, ensure you have ``MulticastDNS=Yes`` @@ -61,10 +61,10 @@ Trusting Your Server's Root CA on Linux sudo systemctl restart systemd-resolved - #. From the folder you have downloaded your Start9 server's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here) + #. From the folder you have downloaded your Start9 server's Root CA, run the following commands. Take care to replace `adjective-noun`` with your server's unique adjective-noun combination in the command below. If you have changed the certificate's filename, be sure to change it here. .. code-block:: bash sudo yum install ca-certificates - sudo cp ".crt" /etc/pki/ca-trust/source/anchors/ + sudo cp "adjective-noun.local.crt" /etc/pki/ca-trust/source/anchors/ sudo update-ca-trust diff --git a/site/source/guides/device-guides/mac/ca-mac.rst b/site/source/guides/device-guides/mac/ca-mac.rst index ecc7f52..8140edc 100644 --- a/site/source/guides/device-guides/mac/ca-mac.rst +++ b/site/source/guides/device-guides/mac/ca-mac.rst @@ -5,7 +5,7 @@ Trusting Your Server's Root CA on Mac ===================================== Complete this guide to trust your server's Root Certificate Authority (Root CA) on Mac. -#. Ensure you have already `downloaded your server's Root CA `_ +#. Ensure you have already `downloaded your server's Root CA `_ #. Locate your downloaded Root CA. Right click it and select *Show in Folder*: diff --git a/site/source/user-manual/backup-restore/backup-synology.rst b/site/source/guides/device-guides/synology/backup-synology.rst similarity index 98% rename from site/source/user-manual/backup-restore/backup-synology.rst rename to site/source/guides/device-guides/synology/backup-synology.rst index 5cc01e3..52b808c 100644 --- a/site/source/user-manual/backup-restore/backup-synology.rst +++ b/site/source/guides/device-guides/synology/backup-synology.rst @@ -10,9 +10,6 @@ Synology Network Folder .. note:: This guide was created by a Start9 community member. This is not yet officially supported. Please report any feedback that may help improve the process. -Setup Network Folder --------------------- - #. In the Synology UI, go to *Control Panel > Shared Folder* and choose the folder you want to use as the destination for the backup. .. note:: Do not select an encrypted folder. Encrypted folders on Synology enforce a character limit of 143 characters. At this time, StartOS backups use folder/file names that are longer than 143 characters. The backup process will fail if you try to backup to an encrypted folder. diff --git a/site/source/guides/device-guides/synology/index.rst b/site/source/guides/device-guides/synology/index.rst new file mode 100644 index 0000000..b82631d --- /dev/null +++ b/site/source/guides/device-guides/synology/index.rst @@ -0,0 +1,29 @@ +.. _dg-synology: + +======== +Synology +======== + +Recommended Guides +------------------ + +.. raw:: html + +
+ +
+ +.. topic-box:: + :title: Backup Config + :link: backup-synology + :icon: scylla-icon scylla-icon--cloud + :class: large-4 + :anchor: View + + Configure a Network Folder for storing StartOS backups + +.. toctree:: + :maxdepth: 2 + :hidden: + + backup-synology diff --git a/site/source/user-manual/backup-restore/backup-truenas.rst b/site/source/guides/device-guides/truenas/backup-truenas.rst similarity index 100% rename from site/source/user-manual/backup-restore/backup-truenas.rst rename to site/source/guides/device-guides/truenas/backup-truenas.rst diff --git a/site/source/guides/device-guides/truenas/index.rst b/site/source/guides/device-guides/truenas/index.rst new file mode 100644 index 0000000..9bd7a95 --- /dev/null +++ b/site/source/guides/device-guides/truenas/index.rst @@ -0,0 +1,29 @@ +.. _dg-truenas: + +======= +TrueNas +======= + +Recommended Guides +------------------ + +.. raw:: html + +
+ +
+ +.. topic-box:: + :title: Backup Config + :link: backup-truenas + :icon: scylla-icon scylla-icon--cloud + :class: large-4 + :anchor: View + + Configure a Network Folder for storing StartOS backups + +.. toctree:: + :maxdepth: 2 + :hidden: + + backup-truenas diff --git a/site/source/guides/device-guides/windows/ca-windows.rst b/site/source/guides/device-guides/windows/ca-windows.rst index 8e19470..a68855f 100644 --- a/site/source/guides/device-guides/windows/ca-windows.rst +++ b/site/source/guides/device-guides/windows/ca-windows.rst @@ -5,7 +5,7 @@ Trusting Your Server's Root CA on Windows ========================================= Complete this guide to trust your server's Root Certificate Authority (Root CA) on Windows. -#. Ensure you have already `downloaded your server's Root CA `_ +#. Ensure you have already `downloaded your server's Root CA `_ #. Ensure you have already `installed bonjour `_ diff --git a/site/source/guides/flashing/flashing-firmware.rst b/site/source/guides/flashing/flashing-firmware.rst index 1bd77fc..f925eed 100644 --- a/site/source/guides/flashing/flashing-firmware.rst +++ b/site/source/guides/flashing/flashing-firmware.rst @@ -9,9 +9,9 @@ The source code can be viewed on Purism's `firmware git repo `_ and extract it. +#. `Download the latest firmware from Purism's git repository `_ and extract it. -#. Copy or move the resulting ``pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-28.rom`` file onto your USB drive, then eject the drive and insert it into your (powered down) server. USB 3.0 (blue ports) will be faster. +#. Copy or move the resulting ``pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-28.1.rom`` file onto your USB drive, then eject the drive and insert it into your (powered down) server. USB 3.0 (blue ports) will be faster. .. note:: You'll need a monitor and keyboard plugged into your server for this operation @@ -35,7 +35,7 @@ The source code can be viewed on Purism's `firmware git repo ` and connect to your server via SSH. Elevate yourself to root once in: + + .. code-block:: bash + + sudo -i + +#. Any previously added Network Folder backup location (or physical drive) will be available. Enter the following command: + + .. code-block:: bash + + start-cli backup target list + + .. figure:: /_static/images/backups/backup-target-list.png + :width: 60% + +#. Select the backup target from the available list. In this example, we could use either ``disk-/dev/sdb1`` or ``cifs-1``: + + .. code-block:: bash + + start-cli backup target mount disk-/dev/sdb1 "YourMasterPasswordGoesHere" + + .. figure:: /_static/images/backups/backup-mount.png + :width: 60% + + The terminal will print the directory where your decrypted backup is now mounted. + +#. `ls` the directory to inspect it, and continue any other operations necessary: + + .. figure:: /_static/images/backups/backup-mount-ls.png + :width: 60% diff --git a/site/source/user-manual/backup-restore/backup-advanced.rst b/site/source/guides/misc-guides/data-mount.rst similarity index 51% rename from site/source/user-manual/backup-restore/backup-advanced.rst rename to site/source/guides/misc-guides/data-mount.rst index 9782e0a..a79f063 100644 --- a/site/source/user-manual/backup-restore/backup-advanced.rst +++ b/site/source/guides/misc-guides/data-mount.rst @@ -1,52 +1,13 @@ -.. _backup-advanced: +.. _data-mount: -===================== -Advanced Backup Tools -===================== +================== +Mount a Data Drive +================== - .. warning:: The following are advanced tools and using them is only advised when under the instruction of a Start9 Support Technician. USE AT YOUR OWN RISK - these operations are not supported outside of the context of support. - -.. _backup-mount: - -Mount a Backup --------------- -#. :ref:`Setup SSH Access` and connect to your server via SSH. Elevate yourself to root once in: - - .. code-block:: bash - - sudo -i - -#. Any previously added Network Folder backup location (or physical drive) will be available. Enter the following command: - - .. code-block:: bash - - start-cli backup target list - - .. figure:: /_static/images/backups/backup-target-list.png - :width: 60% - -#. Select the backup target from the available list. In this example, we could use either ``disk-/dev/sdb1`` or ``cifs-1``: - - .. code-block:: bash - - start-cli backup target mount disk-/dev/sdb1 "YourMasterPasswordGoesHere" - - .. figure:: /_static/images/backups/backup-mount.png - :width: 60% - - The terminal will print the directory where your decrypted backup is now mounted. - -#. `ls` the directory to inspect it, and continue any other operations necessary: - - .. figure:: /_static/images/backups/backup-mount-ls.png - :width: 60% - -.. _backup-mount-data-drive: - -Mount a StartOS Data Drive --------------------------- If you have an encrypted disk from a prior StartOS installation, you can mount its decrypted contents on a Linux computer. +.. warning:: This guide is advanced and should only be used when instructed by a Start9 technician. + #. Attach the StartOS data drive to your Linux desktop or laptop computer. #. Ensure cryptsetup is installed: diff --git a/site/source/guides/misc-guides/index.rst b/site/source/guides/misc-guides/index.rst index 21b6f51..80a16ef 100644 --- a/site/source/guides/misc-guides/index.rst +++ b/site/source/guides/misc-guides/index.rst @@ -11,3 +11,5 @@ Guides that do not fit into the categories of "devices" or "services." lan-ff lan-thunderbird smtp + backup-mount + data-mount diff --git a/site/source/guides/misc-guides/smtp.rst b/site/source/guides/misc-guides/smtp.rst index d8b86e7..d8d3039 100644 --- a/site/source/guides/misc-guides/smtp.rst +++ b/site/source/guides/misc-guides/smtp.rst @@ -1,8 +1,8 @@ .. _smtp: -=================== -SMTP (E-Mail) Setup -=================== +===================== +SMTP Setup (External) +===================== There are several services that are able to take advantage of a Simple Mail Transfer Protocol (SMTP) server in order to send emails. The most common third party SMTP services are GMail and Amazon SES. Some example services that you may wish to use this functionality with are BTCPay Server, Ghost, Gitea, Nextcloud, Synapse, and Vaultwarden. In order to get SMTP credentials for use in a StartOS service, you can follow one of these vendor specific guides. diff --git a/site/source/guides/reset-password.rst b/site/source/guides/reset-password.rst index 819f102..15f6647 100644 --- a/site/source/guides/reset-password.rst +++ b/site/source/guides/reset-password.rst @@ -18,22 +18,22 @@ If you forgot or lost your StartOS master password, you can use this guide to re #. Select "Recover". - .. figure:: /_static/images/setup/screen0-startfresh_or_recover.png + .. figure:: /_static/images/setup/screen0-recover.jpg :width: 60% #. Select "Use Existing Drive". - .. figure:: /_static/images/setup/screen3-use_existing.png + .. figure:: /_static/images/setup/screen3-use_existing.jpg :width: 60% #. Select your server's data drive. - .. figure:: /_static/images/setup/screen4-use_existing_drive_selection.png + .. figure:: /_static/images/setup/screen4-use_existing_drive_selection.jpg :width: 60% #. Enter and confirm a new password. This time, save it somewhere safe! - .. figure:: /_static/images/setup/screen5-set_password.jpg + .. figure:: /_static/images/setup/screen5-set_password_complete.jpg :width: 60% #. Your server will initialize again (all previous data will be recovered). @@ -45,5 +45,5 @@ If you forgot or lost your StartOS master password, you can use this guide to re .. tip:: The "Go to Emassy Login" button will not be usable until you click download. The address information and root certificate contained in this download will not have changed from what you were using before this whole process so if you do not require it you can close this tab and simply go to your server's Lan or Tor address. - .. figure:: /_static/images/setup/setup_complete_pre_download.png + .. figure:: /_static/images/setup/screen7-startfresh_complete.jpg :width: 60% diff --git a/site/source/guides/service-guides/jellyfin/jellyfin-clients.rst b/site/source/guides/service-guides/jellyfin/jellyfin-clients.rst index 1be543e..8677d4c 100644 --- a/site/source/guides/service-guides/jellyfin/jellyfin-clients.rst +++ b/site/source/guides/service-guides/jellyfin/jellyfin-clients.rst @@ -1,4 +1,5 @@ .. _jellyfin-clients: + ================ Jellyfin Clients ================ @@ -21,7 +22,7 @@ Mobile Apps Android ======= -Before proceeding, make sure your Android device has been setup to connect over :ref:`LAN `. If you are connecting over tor, you will need to :ref:`Setup Tor `. +Before proceeding, make sure your Android device has been setup to connect over :ref:`LAN `. If you are connecting over tor, you will need to :ref:`Setup Tor `. 1. Visit the app store of your choice and download the `Jellyfin Android app `_. @@ -31,7 +32,7 @@ Before proceeding, make sure your Android device has been setup to connect over iOS === -Before proceeding, make sure your Apple device has been setup to connect over :ref:`LAN `. If you are connecting over tor, you will need to :ref:`Setup Tor `. +Before proceeding, make sure your Apple device has been setup to connect over :ref:`LAN `. If you are connecting over tor, you will need to :ref:`Setup Tor `. 1. Open the Apple app store and download the `Jellyfin iOS app `_. @@ -40,7 +41,9 @@ Before proceeding, make sure your Apple device has been setup to connect over :r .. figure:: /_static/images/services/jellyfin/jellyfin-iOS-1.png :width: 40% :alt: Server address + 3. Next enter your username and password and tap "Sign In". + .. figure:: /_static/images/services/jellyfin/jellyfin-iOS-2.png :width: 40% :alt: sign in @@ -53,22 +56,28 @@ Desktop Apps MacOS ===== -Before proceeding, make sure your Apple device has been setup to connect over :ref:`LAN `. +Before proceeding, make sure your Apple device has been setup to connect over :ref:`LAN `. 1. Download the .dmg file for `Jellyfin Media Player `_ 2. Upon opening the client, you will be prompted to add server. Click "Add Server". + .. figure:: /_static/images/services/jellyfin/jellyfin-mac-1.png :width: 60% :alt: add server + 3. Next you will be prompted for a server address; paste the URL (``.local`` recommended) from Jellyfin service interfaces and click "Connect". + .. figure:: /_static/images/services/jellyfin/jellyfin-mac-2.png :width: 60% :alt: server address + 4. Next enter your username and password and click "Sign In". + .. figure:: /_static/images/services/jellyfin/jellyfin-mac-3.png :width: 60% :alt: sign in + That's it. You should be connected to your Jellyfin server. If you encounter connection errors, please ensure that you are connected to the same LAN, and there is no VPN active on your Apple device. Other Clients diff --git a/site/source/guides/service-guides/lightning/zeus-cln-direct.rst b/site/source/guides/service-guides/lightning/zeus-cln-direct.rst index 0cab7a4..b850a7d 100644 --- a/site/source/guides/service-guides/lightning/zeus-cln-direct.rst +++ b/site/source/guides/service-guides/lightning/zeus-cln-direct.rst @@ -3,6 +3,7 @@ Zeus ---- .. note:: You must first :ref:`connect to tor on your device`. + Zeus is a powerful mobile wallet that can be connected directly to both LND and Core Lightning. If you'd like to connect via LNbits, which allows allocation of funds, please see :ref:`this guide`. Available For: diff --git a/site/source/guides/upgrade-hardware/drive-upgrade.rst b/site/source/guides/upgrade-hardware/drive-upgrade.rst index 39e1a63..de1dc96 100644 --- a/site/source/guides/upgrade-hardware/drive-upgrade.rst +++ b/site/source/guides/upgrade-hardware/drive-upgrade.rst @@ -30,7 +30,7 @@ Flash StartOS and Transfer Data #. Select "Recover". - .. figure:: /_static/images/setup/screen0-startfresh_or_recover.png + .. figure:: /_static/images/setup/screen0-recover.jpg :width: 30% #. Select "Transfer". diff --git a/site/source/guides/upgrade-hardware/index.rst b/site/source/guides/upgrade-hardware/index.rst index 3301cb4..4527b82 100644 --- a/site/source/guides/upgrade-hardware/index.rst +++ b/site/source/guides/upgrade-hardware/index.rst @@ -37,13 +37,13 @@ Hardware Guides This is for replacing or upgrading your 2022 Server One SSD .. topic-box:: - :title: 2022 One to Pro Migration - :link: upgrade-pro + :title: 2022 One to Pure Migration + :link: upgrade-pure :icon: scylla-icon scylla-icon--enterprise :class: large-4 :anchor: View - This is for migrating from a Server One (Raspberry Pi) to Server Pro + This is for migrating from a Server One (Raspberry Pi) to Server Pure .. topic-box:: :title: Upgrade to all-in-one NASPi case @@ -63,6 +63,6 @@ Hardware Guides lnd-migration drive-upgrade - upgrade-pro + upgrade-pure naspi-upgrade naspi-ssd-upgrade diff --git a/site/source/guides/upgrade-hardware/naspi-ssd-upgrade.rst b/site/source/guides/upgrade-hardware/naspi-ssd-upgrade.rst index 0ca747a..48723a0 100644 --- a/site/source/guides/upgrade-hardware/naspi-ssd-upgrade.rst +++ b/site/source/guides/upgrade-hardware/naspi-ssd-upgrade.rst @@ -93,7 +93,7 @@ This is not the same as running a back up and restoring them onto a new server. #. Select "Recover" - .. figure:: /_static/images/setup/screen0-startfresh_or_recover.png + .. figure:: /_static/images/setup/screen0-recover.jpg :width: 60% #. Select "Transfer" diff --git a/site/source/guides/upgrade-hardware/upgrade-pro.rst b/site/source/guides/upgrade-hardware/upgrade-pure.rst similarity index 89% rename from site/source/guides/upgrade-hardware/upgrade-pro.rst rename to site/source/guides/upgrade-hardware/upgrade-pure.rst index 3f697c8..ef79cf2 100644 --- a/site/source/guides/upgrade-hardware/upgrade-pro.rst +++ b/site/source/guides/upgrade-hardware/upgrade-pure.rst @@ -1,4 +1,4 @@ -.. _upgrade-pro: +.. _upgrade-pure: ============================================= Migrating From 2022 Server One to Server Pure @@ -45,7 +45,7 @@ You will need a high quality `USB-A to USB-A cable ` and :ref:`FAQ` for that particular Service. You can also check the "Logs" (on the service page), 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. diff --git a/site/source/support/concepts/start9-startos.rst b/site/source/support/concepts/start9-startos.rst index e694e01..95e76d5 100644 --- a/site/source/support/concepts/start9-startos.rst +++ b/site/source/support/concepts/start9-startos.rst @@ -18,9 +18,9 @@ Server One ---------- Server One is a plug 'n' play hardware device, based on the `Intel NUC `_, assembled in-house by Start9. The current iteration features an internal SSD, speaker, active cooling, and power management in a custom AIO (all-in-one) case. The Server One comes pre-loaded with :ref:`StartOS`. For more details, check out the `Server One tech specs `_. -Server Pro ----------- -Server Pro is a plug 'n' play hardware device, based on the `Librem Mini `_, built by `Purism `_. Pro features a custom-built circuit board with active cooling, and an open-source firmware / boot stack. The Server Pro comes pre-loaded with :ref:`StartOS`. For more details, check out the `Server Pro tech specs `_. +Server Pure +----------- +Server Pure is a plug 'n' play hardware device, based on the `Librem Mini `_, built by `Purism `_. Pure features a custom-built circuit board with active cooling, and an open-source firmware / boot stack. The Server Pure comes pre-loaded with :ref:`StartOS`. For more details, check out the `Server Pure tech specs `_. .. _start-os: diff --git a/site/source/support/faq/faq-basic-use.rst b/site/source/support/faq/faq-basic-use.rst deleted file mode 100644 index e4f4322..0000000 --- a/site/source/support/faq/faq-basic-use.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. _faq-basic-use: - -============= -Basic Use FAQ -============= - -.. contents:: - :depth: 2 - :local: - -Is it easy to use? ------------------- -Yes! A Start9 server is designed to be plugged into power and internet, and after a short setup, is immediately ready to use. Getting services is as easy as getting apps for a smartphone. -As with anything new, you should expect to spend a little time learning the functions and features, and keep in mind that some services may be more complex to understand and use than others. - -So I can run my own cloud? --------------------------- -Yes! No special skills or knowledge are required to host all your own services and replace those previously thought "necessary" for modern digital life. - -Can I run multiple Start9 servers? ----------------------------------- -Yes, but there is currently no way to synchronize or federate them. We are working on ways to make this possible in the future. - -Can I still use my VPN? ------------------------ -The short answer is yes, but they can cause some conflicts when accessing your server. If you need to troubleshoot, turning off your VPN is a good place to start. The following VPNs are known to not interfere with the proper settings enabled: - -- Mullvad - Go to "Settings -> VPN Settings -> Local Network Sharing" - enable this option to be able to access your server's ``.local`` addresses. -- ProtonVPN - Go to "Preferences -> Connection -> Allow LAN Connections" - enable this option to be able to access your server's ``.local`` addresses. -- iVPN - Go to "Settings -> IVPN Firewall -> LAN settings -> Allow LAN traffic when IVPN firewall is enabled" - enable this option to be able to access your server's ``.local`` addresses. - -What if I forget my StartOS password? -------------------------------------- -Please follow the :ref:`password reset guide`. - -Can I move my server to another location? What happens when I do this? ------------------------------------------------------------------------- -Yes, you can move your server to another network. Your service tor addresses will remain the same. Remember that you can only access via LAN if you are accessing with a device on the same network as your server. - -What's the advantage of using the .local address over the .onion address? -------------------------------------------------------------------------- -If you are in your home/office network with your server, it is both faster and more private since the connection never leaves your household/office. The downside is that it won't work if you're on the go. - -Can I use the .local addresses over the Tor Browser? ----------------------------------------------------- -No. The Tor Browser requires all web visits to first enter the Tor network. Once you have entered the Tor network there is no way to exit the Tor network in such a way that .local/mDNS addresses resolve. - -Can I use .local addresses on Android? --------------------------------------- -Yes. Support was added in version 12 of Android. For custom ROMs, such as Calyx and Graphene, version 13 is required. - -Can I have multiple users on StartOS? -------------------------------------- -Currently, StartOS itself is designed for a single user. There is no way to grant others access to your server without sharing your personal, master password, which is not recommended. There are certain services, however, such as Vaultwarden, File Browser, and Nextcloud, that do support multiple users (aka the "Uncle Jim" model) where people who trust you (and vice versa) can create their own, personal accounts for these services. Just remind them that they are trusting you with their data, and that it might be preferable for them to take the final leap of sovereignty and get a server of their own. - -Multi-tenancy is a desired future OS feature. Stay tuned. - -What can I do if I am having issues connecting to a mobile app over Tor? ------------------------------------------------------------------------- -The best solution to connection issues is normally to restart Orbot, or to reboot the phone. This will solve most common problems. - -If I uninstall a service, then re-install it, does my data remain? ------------------------------------------------------------------- -No. When uninstalling a service, you completely destroy everything associated with it. This is because each service runs in it's own 'container', which includes all the required software and operating system environment that it needs to function. When uninstalling, this container is wiped from StartOS, and with it, any associated service data that you have not backed up. - -This can be useful, as you may want to wipe a service and start anew. For example, you might want to receive a fresh Tor .onion address, or to spin up a new Lightning node. However, if you do this, YOU MUST BE 100% CERTAIN THAT YOU ARE PREPARED TO LOSE ALL DATA for this service. Also, keep in mind that other services may depend on the service you are uninstalling. - -Do I need to delete existing backups before doing a new backup? Or does a new backup override the old backup? -------------------------------------------------------------------------------------------------------------- -No, you don't need to delete the old backups. The technology we use updates the existing backup. This is known as a "diff-based" model, where the "difference" in backups is what is recorded. - -Can I clone my SSD for backup purposes? ---------------------------------------- -.. warning:: **DO NOT do this if you are running LND or CLN**. If you clone the SSD, then go back to running LND or CLN, and you *ever* try to restore the SSD, there is a good chance you will lose *all your channel funds*. Also, if you try to use the SSD for a 2nd server, that will also result in loss of funds. This has nothing to do with Start9 or StartOS; it is inherent to the architecture of Lightning. - -It is neither necessary, nor recommended to do this. If you need to copy all data to a new drive because you are migrating or upgrading hardware, check out the :ref:`"Transfer" option explained here`. - -Why would I even buy this when I can just build it for free? ------------------------------------------------------------- -(1) You will get white glove support in your preferred format, from text chat to screen sharing conference calls. - -(2) Supporting the project. Buying a server from Start9 is your way of supporting the development of the project. And it's not just out of gratitude, but rather, a recognition that if the project isn't funded, the cool software stops coming. - -(3) Convenience. This is the big one. It's true, some people will choose to use the software without buying a server, but most will not. Very few people on Earth are comfortable using the command line, compiling code, and configuring an OS. Furthermore, hardware is necessary. Sure, some people already have a Raspberry Pi, and others may try to re-purpose an old laptop, but many people would be choosing between buying the hardware components themselves and assembling vs buying pre-assembled at a reasonable markup. - -Bottom line...We are charging a marginal rate for something incredibly powerful, and we think the convenience of a plug-and-play device, free service marketplace, and white glove support is where the money is. Anyone could build their own couches too, but here is a reason furniture stores exist. How much is your time worth? - -My server came with a 'product key,' or similar unique code - what is that? ---------------------------------------------------------------------------- -This will entitle you to white glove support as well as future benefits yet to be announced. diff --git a/site/source/support/faq/faq-bitcoin.rst b/site/source/support/faq/faq-bitcoin.rst deleted file mode 100644 index 169e97c..0000000 --- a/site/source/support/faq/faq-bitcoin.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. _faq-bitcoin: - -=========== -Bitcoin FAQ -=========== - -.. contents:: - :depth: 2 - :local: - -Why does the Bitcoin service take so long to be ready? ------------------------------------------------------- -On first install, the Bitcoin service must verify the entire history of transactions in order to verify transactions going forward. This can take up to a week depending on your hardware and internet connection. You can continue to use your server normally during this sync. -You can learn more about the Initial Block Download in `this video `_. - -.. youtube:: OrYDehC-8TU - :width: 100% - -Can the IBD (Initial Block Download) be made faster? Or can wait times be improved? ------------------------------------------------------------------------------------- -The only way to improve IBD speeds will be to upgrade your hardware or Internet connection. - -Does StartOS run a full archival Bitcoin node or a pruned one? --------------------------------------------------------------- -The option is yours. In the Bitcoin Config, find the section on pruning to prune to specified sizes, or turn pruning off entirely for a full archival node. Please keep in mind that a full archival node will take up between approximately 500GB of your data drive as of 2023. If you have a small disk, StartOS will change Bitcoin's config to prune. - -What actions, specifically, are only possible with an archival, or 'unpruned' node? ------------------------------------------------------------------------------------ -Generally, the more sophisticated the blockchain analysis being done is, the more index data is required, which will increase the system resources required. For example, if you wanted to run a block explorer (such as the Mempool service), you would require not only a full archival node, but also a full transaction index. So, specifically, at this time, a full archival node is required for running an Electrum server, a block explorer, and for doing advanced chain analysis in general. - -Is it insecure to run a pruned node? ------------------------------------- -As a user, pruned nodes and archival nodes provide you the same security. In a larger sense, if 100% of people ran pruned nodes, the security of the network could be in dire circumstances and be put at risk if no nodes kept history, as then no one could bootstrap new nodes. The reality however, is that most StartOS users are new node operators, so there is no net systemic risk introduced if users decide to run a pruned node. - -The Bitcoin Service is different from the GUI version I am used to using (bitcoin-qt). How do I use this like I used to? -------------------------------------------------------------------------------------------------------------------------- -At present, StartOS does not offer its own node visualization tool (although this is planned). You can view certain properties about your node inside the "Properties" section, but not in an animated GUI. If you want to use bitcoin-cli, you may do so by adding an SSH key to your server and :ref:`exec-ing into the bitcoind docker container` (advanced). Otherwise, the main way to actually *use* your node is through a wallet. The QT GUI is not usable because it cannot be served through the browser (which is necessary here), and last we checked, the QT desktop client was incapable of connecting to a remote node over Tor. - -Is a wallet vulnerable to hacking if it's always online? ---------------------------------------------------------- -Funds (private keys) are not typically stored on the node. The node simply serves as a source of truth for the state of the blockchain. Attacks depend on where the keys are and where the signing happens. You can use something like a hardware wallet or paper wallet for better security. Though, to be fair, a lot of attacks depend on you or your machine being targeted specifically, and many attack vectors are highly theoretical and obscure. - -Most successful attacks seem to be either fake/doctored software or a social attack (tricking you into installing some malware or giving up your private seed/keys). -Keep in mind, however, the more value there is out there to steal, the more sophisticated attacks will get automated (bots, crawlers etc). So its not just the risk profile of today, but also tomorrow you have to consider. That's why something like a hardware wallet or dedicated mobile device for key signing is a good idea. -Even if your wallet is plugged into your server, whether your wallet is hot or cold depends on the hardware that stores the keys. - -How do I use Bitcoin Core as a wallet? --------------------------------------- -Bitcoin Core is a full node that also contains wallet functionality. Some will be familiar with Bitcoin-QT, which is a Bitcoin Core GUI that for a long time was the only available wallet. This is currently not compatible with StartOS. You can use the wallet in Bitcoin Core, however it is for advanced users and is only available in the command line via SSH. - -It is helpful to think of the Bitcoin Core service on StartOS as your own personal Bitcoin Server. This is your own verified source of truth of the Bitcoin ledger, that requires no permission for you to set up and own. The job of your Bitcoin server is to verify that the transactions you want to make and receive are valid. - -There are modern wallets that have the ability to use your personal Bitcoin node as a source of truth, and with the advantages of additional security and advanced features. This also follows the Unix mantra of "do one thing and do it well." The recommended way to use your Bitcoin node is with an :ref:`external wallet`. - -Which wallets can I use that integrate with my Bitcoin and/or Lightning nodes? ------------------------------------------------------------------------------- -Please see the :ref:`Bitcoin Integrations` and :ref:`Lightning Integrations` for all the currently supported options. - -I want to use my hardware signer, such as Coldcard or Trezor, with my Bitcoin node. How does this work? --------------------------------------------------------------------------------------------------------- -You do not use hardware signers directly with your node. Hardware signers interface with wallets, and wallets interface with nodes. Here is what the stack looks like: - -Node (on StartOS) <— Wallet (Specter, Sparrow, Electrum) <— Hardware signer (Coldcard, Trezor) - -You use your hardware signer with your wallet, then instruct that wallet to use your Bitcoin node as its node. - -- Nodes are for interacting with the Bitcoin network: enforcing consensus rules, validating and relaying blocks/transactions, and broadcasting transactions. - -- Wallets are for constructing and viewing transactions, as well as generating addresses. - -- Signers are for generating and storing keys, as well as signing transactions. - -The reason there is so much confusion about these 3 concepts is that the Bitcoin Core node comes with its own Wallet (which you should not use), and that wallet is also a signer. In fact, most wallets double as signers, and many wallets do NOT support connecting to your own node. So, most wallets are actually serving as a wallet, linked to a third party node, and a signer, which might be convenient, but it is neither trustless nor maximally secure. Ideally, you are using a wallet that supports both integrating with a hardware signer (like Coldcard or Trezor) AND a backend node (like on StartOS). diff --git a/site/source/support/faq/faq-contributing.rst b/site/source/support/faq/faq-contributing.rst deleted file mode 100644 index a77b539..0000000 --- a/site/source/support/faq/faq-contributing.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _faq-contributing: - -================ -Contributing FAQ -================ - -.. contents:: - :depth: 2 - :local: - -We ❤️ contributions! - - -How can I contribute to StartOS? --------------------------------- -Please follow the guide `here `_ and reach out to the `Community Dev `_ channel on Matrix with any questions. - -Do I need to be a professional developer or have coding experience to contribute? ---------------------------------------------------------------------------------- -Absolutely not! Contributions can be as simple as finding a typo in our docs, making a suggestion on GitHub, creating educational or promotional content, spreading the word, and the list goes on! Everyone that wants to contribute can do so in some unique way. - -First check our `Contributing `_ page and please don't hesitate to `Contact `_ us for ideas if you're not sure where to begin. diff --git a/site/source/support/faq/faq-general.rst b/site/source/support/faq/faq-general.rst deleted file mode 100644 index 8facf41..0000000 --- a/site/source/support/faq/faq-general.rst +++ /dev/null @@ -1,121 +0,0 @@ -.. _faq-general: - -=========== -General FAQ -=========== - -.. contents:: - :depth: 2 - :local: - -What is Start9 Labs? --------------------- -Start9 Labs is a small, but quickly growing group of builders based in Denver, USA (with a global team) that build Start9 servers and StartOS. - -What is a Start9 server? ------------------------- -A Start9 server is a "shelf-top" personal computer running StartOS as its operating system. - -The internet as we know it is organized into questioners, or clients, and answerers, or servers. When you open a mobile email app, say Gmail, the app (client) begins asking questions: "have I received new mail?", "what are my last 50 messages?", "what drafts am I in the midst of writing?", and so on. Your app's questions are sent to and heard by a Google-run server which then provides answers back to the client and are subsequently displayed to the screen. - -A server is exactly that: your very own "answerer", just like Google's, except managed simply and with ease by and for you alone. - -In other words, it is a generalized private personal server capable of running all sorts of self hosted open source software. - -When you see your credit card information on your banking app, your messages in your texting app, your passwords in your password management app, all of that information comes from somewhere in the cloud: some server run by some company somewhere on the planet. Who can see the data stored in that server? Who can edit it? It's not always clear, but the increasingly common practice of selling your data to advertisers and the high-profile cyber-security breaches of the last decade suggest a pessimistic outlook. - -One thing is for certain though: if you control your server, then you control your data. Your finances, your communications, all of it is actually yours -- and only yours. - -Why do I care? --------------- -As an example, let's talk about the password manager, Bitwarden. It may help convey the concept of a personal server. Currently, if you sign up with Bitwarden, your passwords are stored on a physical device (aka server) owned and operated by the Bitwarden team. Your phone or laptop sends requests to their server when you want to do anything: create an account, create a new password, retrieve existing passwords, etc. Your passwords are stored on their device, encrypted with your Bitwarden password. They are the custodian of your passwords, similar to getting a safe deposit box at the bank. The bank keeps your valuables in their vault, presumably they don't know what's in the box, and any time you want access to your box, you ask the bank for permission. This is exactly how a hosted Bitwarden experience works, as well as just about everything on the internet. - -When you install Bitwarden on StartOS, by contrast, it's like building your own safe deposit box in a private bunker whose location is only known to you and whose keys only you posses. You create an account with yourself, store your passwords with yourself, etc. You are your own custodian. This same concept can be applied to just about everything on the Internet, without losing the convenience of the custodial model, which is what we are out to accomplish. This may sound cool, or neat, but it is so much more than that. The custodial data model is amongst the greatest threats to human liberty the world has ever seen. - -This `podcast `_ may help expound upon why this is important. - -.. youtube:: aylDowaSdzU - :width: 100% - -How does StartOS work? ----------------------- -StartOS (see next FAQ) is based on Linux and handles all operations on your server. This core element of the technology stack is what enables you to set up, login, access your server's dashboard, and install services. - -One of these operations is creating and managing Tor addresses, which are uniquely attributed to each service you download, as well as to the server itself. You can see your uniquely generated Tor address when you complete the setup process. This address is how you view your server's dashboard, which is actually just a website hosted by your server itself! It is authenticated, of course, so only you can access it. - -You can connect to and manage your server from your mobile device, desktop computer, or laptop computer. This is accomplished in the browser by visiting your server's private and unique URL. - -Once on your server's web page (the StartOS dashboard), you can choose what services to install. Then, each installed service also receives its own private and unique URL, such that you can access it from the browser or any mobile app that supports using it as a backend. - -The list of services will grow rapidly over the coming months and years, such that most or all the things you currently do using cloud-based third party servers can be just as easily accomplished using your own personal cloud serving your own personal software and storing your data privately. No trusted third parties at all. - -What is StartOS? ----------------- -StartOS is a new kind of Linux Operating System (OS). It is a built from the ground up to allow anyone to easily run a private "cloud," become independent from Big Tech, and own their own data. - -StartOS is custom-built Linux distribution (currently based on Debian) with a suite of software tools which make it easy to: - -* Install, uninstall, and upgrade services from a Marketplace registry (similar to your phone's app store) -* Manage and run services that YOU own and control -* Upgrade StartOS with the latest features and security updates -* Backup services and data, and restore from backups if needed - -It includes: - -* a custom application management layer, specialized for installing, running, and backing up ``.s9pk`` packaged services -* a layer responsible for StartOS specific operations, such as Networking, Backups, and Notifications -* a system of :ref:`Health Checks` for simple monitoring and metrics -* an SDK for developers, including an "Actions" API to simplify complex operations for the common user -* and much, much more - -The ``.s9pk`` extension is Start9's custom package format based on ``tar``. It encompasses the necessary components to compress, host, and install a service on a Marketplace registry. - -What are StartOS Services? --------------------------- -A Service can be any piece of software added to a Marketplace registry. Unlike "apps," services are (usually) "server-side" software, meaning they are intended to run 24/7/365 and listen for requests from your clients (apps). 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 Start9 ship worldwide? ---------------------------- -We ship everywhere that DHL ships. Please consider that in some countries, the VAT and Customs fees are so ridiculous that they cost as much as the server itself. You may wish to consider buying your hardware locally and building your own device, downloading StartOS from our github, and `donating `_ to us. Please see the :ref:`DIY` page for details. - -Do you have international electrical plugs? -------------------------------------------- -Power supplies for the EU, AU, US, and UK standards are usually available. - -Are the power supplies 220v compatible? ---------------------------------------- -Yes. Start9 server power supplies are typically rated for 100-240V. - -Does StartOS have a license? ----------------------------- -StartOS is published under our own Start9 Non-Commercial License, which has similar properties to many open source licenses with the exception that users cannot in any way, either through products or services, commercialize the source code, and any changes to the code or derivative works of the code are treated in the same manner. This means people will be welcome to access the source code, download it, use it, run it, fork it, change it, improve it - whatever they want - except sell it or sell services related to it. - -Is there a product warranty? ----------------------------- -Yes! The full warranty for a device purchased from us is located on the insert in the box (1 year). Furthermore, Start9 commits, to the best of our ability, to serving our users. We will resolve any issue encountered with our provided hardware or software in a personalized manner. We strive to provide highly available, quality customer service. - -What kind of Internet connection does a server require? -------------------------------------------------------- -In general, any modern Internet connection is usually fine. We have had reports from users on rural satellite connections with high latency (ping), and low up/download speeds who had issues accessing via Tor. You can check your internet connection at `SpeedTest `_ to find your ping and speed. If your ping is higher than 200ms and/or your speeds are lower than 5Mbps, you may want to locate your server somewhere with a better connection. Please don't hesitate to `contact us `_ with any questions. - -I run a business, can I use StartOS for tasks such as password management and file sharing? -------------------------------------------------------------------------------------------- -Absolutely. A Start9 server would be a great addition to any business as it is easy to use and provides services that you control, with no subscription fees. You can even run your own payment processor and accept cryptocurrency payments with no third party necessary! - -What are you using for a store backend? Do you store my data? --------------------------------------------------------------- -Here is our exact situation currently: -Credit card sales are processed through Shopify, which we do not like, but it was expedient in the early days, especially for shipping, so we went with it. Aside from a master list of email addresses for those who have explicitly opted in to our mailing list, all customer credit card data is stored within Shopify. We do not duplicate it anywhere. We ask Shopify to delete our customer data, but they claim it takes upward of 3 months to comply and we of course have no guarantee the data will actually be deleted permanently. This is partly why we exist...as such, we are moving off of Shopify and onto a self-hosted solution, where Start9 alone controls our customer data for purchases, which we will delete as a matter of policy following a short grace period after delivery. - -Enter our `Bitcoin Store `_! Way less personal information is required to purchase with Bitcoin/Lightning, we offer a discount for these payment methods, and we routinely delete customer data. - -Finally, you can always assemble the hardware yourself and download StartOS for free. - -I want to help, but I'm not a developer. Are there any ways for non-coders to contribute? ------------------------------------------------------------------------------------------- -1. Shill it to everyone and create awareness -2. Answer questions from new users in the community channels -3. Make tutorial videos -4. Write instruction manuals or commit to the docs - -Check out the `Contribute ` page for more details. diff --git a/site/source/support/faq/faq-lightning.rst b/site/source/support/faq/faq-lightning.rst deleted file mode 100644 index d48a49d..0000000 --- a/site/source/support/faq/faq-lightning.rst +++ /dev/null @@ -1,101 +0,0 @@ -.. _faq-lightning: - -========================= -The Lightning Network FAQ -========================= - -.. contents:: - :depth: 2 - :local: - -Why would I want to run a lightning node? ------------------------------------------ -The Lightning Network (LN) is a second 'layer,' built on top of the Bitcoin Protocol. As a result all transactions on LN are backed up by the full security of the Bitcoin network. Lightning is designed for instant payments between nodes, but similar to running a Bitcoin node, running your own is the only way to be sovereign. When you have your own node, you will have the convenience of linking a Lightning wallet, for use on the go. It is also possible to earn an income (granted a very small one at this time), if you are willing to learn how to become a 'routing node.' - -How can I get started with Lightning and open my first channel? ---------------------------------------------------------------- -You can check out our `"Using Lightning" video `_ and learn the basics, including opening a channel with Start9. - -.. youtube:: KhU_sTiaN8w - :width: 100% - -Please remember to always open a "Private" channel with us, or your channel is likely to be closed. Please don't hesitate to reach out to us with any questions. - -I opened a Lightning channel, but my local balance is lower than I expected. Where is the remainder? ------------------------------------------------------------------------------------------------------ -A fee to close the channel (onchain) is set aside at opening. - -How is that fee estimation calculated? --------------------------------------- -The commitment fees are automatically negotiated every few blocks with your peer. They are on chain txs like all channel closes but they are not broadcast until you attempt to close the channel. - -What would happen if I shut down StartOS while it is running a Lightning node with open channels? -------------------------------------------------------------------------------------------------- -It is REALLY IMPORTANT to understand that if Lightning services are shut off for long periods of time (several days or more) it is possible for your peers to cheat you out of money. If you are not prepared to LOSE ALL THE MONEY IN YOUR CHANNELS, KEEP YOUR NODE RUNNING. -That said, malicious actors on the network right now are probably sparse, and you may choose to only open channels with friends that may be a lot nicer to you if your node is not active. - -Is there a solution to this? ----------------------------- -Yes, the concept of a Watchtower was originally conceptualized in the LN whitepaper. A Watchtower is simply a lightning node to which you can give the authority to monitor transactions associated with your open payment channels. - -Is it possible to run Core Lightning and LND in parallel on StartOS? --------------------------------------------------------------------- -Yes, you may run both. They will operate in their own environments and allow you to run services that depend on either. - -How do I connect my Lightning wallet or mobile app to my Start9 server? ------------------------------------------------------------------------ -Please see the :ref:`Lightning Service Guides` section for more details. - -Are my addresses, channels, and balances all stored in LND/Core Lightning, or RTL, Zeus, etc? ---------------------------------------------------------------------------------------------- -This is all on your Lightning node (LND or Core Lightning), including on-chain funds, while RTL (or Zap, Zeus, etc) is just a GUI for accessing your node. - -How do I find my LND seed so I can write it down to backup? ------------------------------------------------------------ -LND backups are best done via StartOS's backup flow, and this is the ONLY supported backup method. It is NOT supported to backup/restore from the seed. Everything crucial is backed up by our backup system, so you do not need the seed. The seed is ONLY for the onchain wallet and does NOT backup your channel state. That said, there was a high user demand to expose the LND Aezeed, and so, as of LND v0.16.4, this will be made available (on fresh installs only - as that is the only time Lightning Labs exposes this seed). - -To clarify some of the reasons behind this issue: - -First off, Lightning is fundamentally different than on-chain/Layer 1 (L1) Bitcoin. There is no way to compress all of that information down into a single 24 word seed in such a way that it will continue to work throughout your usage of the Lightning Network. - -So, what is the LND seed *for*? In short, the seed is only used for the Layer1 portion of the funds you have locked up in LND. Due to the live nature of LND and lightning nodes in general, we tend to discourage keeping any significant amounts of money in the onchain portion of your wallet. Given that we cannot actually recover the Layer 2 (L2) funds with that seed, we needed to have a more holistic way to backup LND funds such that the backup would encompass the ability to get L2 funds back. The StartOS backup system does this, and this approach also happens to be a perfectly valid backup of your L1 funds as well. While Bitcoin users have been trained that the 24 word seed can be used to recover all of their funds, it is important to understand that lightning does not and cannot work this way. Exposing the seed gives you two separate things to keep track of in order to recover your funds instead of just one. - -How does the StartOS backup system handle Lightning (CLN and LND) backups and recovery? ---------------------------------------------------------------------------------------- -CLN/LND backups on StartOS consist of onchain funds and the set of channels. The node implementations (upstream) do not contain channel balances in the backup systems they use. - -When you need to perform a recovery, it is important to understand all possible consequences. For most recoveries, such as a password reset, or hardware upgrade, there is no need to do a restore from backup. The preferred methods (:ref:`explained here`) are to "Attach" your existing data, or "Transfer" it. - -If you do need to do a disaster recovery, your node reaches out to channel counterparties and requests that they force close the channel at the current balances. You are "trusting" them to report the correct balances. "Trusting" in quotes, because it would be very dangerous for them to try to cheat. They have no way of knowing that you are unaware of the true channel state. If they try to broadcast a revoked channel state, you could take all their money. - -This is the current state of Lightning backups, and we will continue to stay at the forefront to help users protect their funds. - -Why are Lightning Network backups and moves so complicated? ------------------------------------------------------------ -There are safe ways to do an “atomic move” of a LN node, but it requires a very specific sequence of actions and certain mistakes can result in your counterparties taking all your funds. Currently, LN works on a punishment scheme. This means if you publish revoked state, the counterparty is entitled to a claim on all the funds in the channel. This incentive system is what makes the whole system work. Without it, LN would be subject to various kinds of thievery. - -The downside is that backups of old state are not safe. This is because your node might believe it is the real state of the channel, but it may be unaware of states created since then. The problem here is that your node naively believes something different from the truth, which can result in all of the funds being lost. In response to this reality, the safe backup systems, including those generated by RTL, actually do not include channel state. They only list the peers that you had channels with. Restoring these backups essentially politely asks your peers to force close the channels they have with you. In those moments it is possible for your peer to try and cheat you, but they cannot be 100% sure that you can't punish them, so it's extremely unlikely that they will attempt to do so. - -Is there a way to use the channel backups made within RTL? ----------------------------------------------------------- -We do not support this. Please see the above FAQ. - -When attempting to add new peer, RTL says "server is still in the process of starting," but chain state seems to be fully up to date. What can I do? ------------------------------------------------------------------------------------------------------------------------------------------------------ -Check the LND logs, it can take a while to bootstrap, and starting RTL before this completes could cause errors. - -I get an error ("Unlock Wallet Failed") when trying to log in to RTL, what can I do? ------------------------------------------------------------------------------------- -Stop and Restart the Service. - -"Server is still in the process of starting," but LND and RTL are running. How can I address this? ---------------------------------------------------------------------------------------------------- -You may need to restart the LND Service. - -I get the following error from LND: "Error ECONNREFUSED Fetching Info Failed! Unknown Error." What's wrong? ------------------------------------------------------------------------------------------------------------ -LND is waiting for Bitcoin to completely sync, and then needs to catch up on block scanning itself. This may take several minutes, and in some cases might require a restart of the LND service. Do this if the process takes more than 5-10 minutes. - -What's the best way to move a small lightning balance? ------------------------------------------------------- -It is possible to have lightning balances that are so low that they will not (or barely will) cover the on-chain fees to recoup into an on-chain wallet. If possible, move them to another Lightning node. diff --git a/site/source/support/faq/faq-service-packaging.rst b/site/source/support/faq/faq-service-packaging.rst deleted file mode 100644 index bb93f14..0000000 --- a/site/source/support/faq/faq-service-packaging.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. _faq-service-packaging: - -============= -Packaging FAQ -============= - -.. contents:: - :depth: 2 - :local: - -Do I need programming experience to package a service for StartOS? ------------------------------------------------------------------- -It would be helpful, but is not a pre-requisite. Linux, dev-ops, and/or systems administration experience would all be helpful as well. Keep in mind that everyone has to start somewhere, and perhaps your journey to development begins with packaging a service for StartOS! - -What considerations are there when choosing a service for packaging? --------------------------------------------------------------------- -There are several things you will want to consider. Requirements include: - -#. Most importantly, pick a service you are passionate about seeing on StartOS -#. Make sure it is :ref:`Open Source ` -#. A service that incorporates a 'self-hosting' option, or is capable of being self-hosted - -Recommendations that may ease the process: - -#. A service that has already been 'dockerized' (has a **working** ``Dockerfile``) -#. A service written in a language you are familiar with -#. A service with a strong community - -You can check this expansive list if you are in search of ideas: `Awesome Self-Hosted `_ - -What if I don't need a Config in my service? --------------------------------------------- -Config files can be empty( ``{}`` ), if you do not require config. `File Browser `_ is an example of a service with no Config. - -How can my service access the data directory of another service? ----------------------------------------------------------------- -#. Provider service needs to expose datadir to other services on StartOS -#. Consumer services needs to list the provider service as a dependency AND set a particular config value, stating that it wants data from that particular service - -Check out `LND `_ and `RTL `_ as an example. - -Why am I getting the error "No rule to make target yq, needed by manifest.yaml?" --------------------------------------------------------------------------------- -This is the message you get when you're missing the yq executable on your ``$PATH``. You can find details to `install yq here `_.` \ No newline at end of file diff --git a/site/source/support/faq/faq-services.rst b/site/source/support/faq/faq-services.rst deleted file mode 100644 index d72791c..0000000 --- a/site/source/support/faq/faq-services.rst +++ /dev/null @@ -1,92 +0,0 @@ -.. _faq-services: - -============ -Services FAQ -============ - -.. contents:: - :depth: 2 - :local: - -What if I cannot connect to a Service? --------------------------------------- -Please make sure the service is started by viewing it in the Services tab in the StartOS dashboard menu. A green indicator bar should be visible. - -Will there be a VPN? --------------------- -There will be more on this style of functionality following StartOS v040. - -Will there be an email server? ------------------------------- -We do hope to add this functionality one day, however it has some technical challenges, and is not currently a high priority. If you would like to tackle this and help us get a self-hosted email server on StartOS, please reach out in our Matrix or Telegram `dev channels `_, and we will be happy to help in any way that we can. - -Can StartOS run 'X' Service?? ---------------------------------- -Potentially. Here is a `comprehensive list `_ of self-hosted services, any of which can theoretically be run on StartOS. To get a general idea of what is required, answer these questions: - -1. Is the software designed to be self-hosted? -2. If it has a P2P interface, does that interface support Tor? -3. Does it ship with it's own web interface? Or is there a Tor-enabled client app? -4. Is there someone willing to put in the time to package it up? - -If all answers are yes, then it can run on StartOS. Following OS v040, the Tor requirements will be dropped. - -Packing up a service for StartOS 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 a Marketplace registry so anyone can run it on StartOS. You don't need our permission. See more on our strategy in `this blog post `_. - -Does StartOS operate as a Tor relay node? ------------------------------------------ -No, currently it does not, but we plan to add that functionality as an option. - -Are files on my server encrypted on disk? ------------------------------------------ -Yes, but not in a way that would prevent a sophisticated attacker. Physical access should be considered root access. - -I get an error ("Unlock Wallet Failed") when trying to log in to RTL, what can I do? ------------------------------------------------------------------------------------- -Stop and Restart the Service. - -What is happening if I cannot connect with another user on Mastodon? --------------------------------------------------------------------- -You can only follow someone who has an account on a Mastodon server that supports Tor. It is a new feature, so many instances do not have it yet. Other issues are typically related to the tor connection, check your tor daemon, orbot, or try to restart the service. - -What does it mean when Vaultwarden says "This browser requires HTTPS to use the web vault" upon creating an account or loging in to my Vaultwarden onion? ---------------------------------------------------------------------------------------------------------------------------------------------------------- -You will need to tell your browser to treat .onion URLs as a "secure context". You will need to follow this guide to configure :ref:`Tor on Firefox`. - -Can the browser extension be used with Bitwarden hosted on StartOS? -------------------------------------------------------------------- -Yes, but only in a tor-enabled browser. Just add your .onion address as the server in the extension. Make sure that http:// is at the beginning, and NOT https://, as this will not work. - -You can use your .local address, but remember that you will only be able to sync when on your :ref:`LAN`. - -I want to use BTCPayServer on my website, but Tor is the only option, how can visitors access my BTCPay on clearnet? --------------------------------------------------------------------------------------------------------------------- -As StartOS produces a Tor Hidden Service for each service, BTCPayServer is only available via Tor by default. For a brick and mortar business, this is no problem as you can use your own device for a customer to pay you on. If you run your own website, it is possible to set up a reverse proxy in order to serve BTCPay content to your clearnet visitors. A guide to doing this is available in the `BTCPayServer docs `_. - -We understand that this can be a frustrating limitation, and adding clearnet support is high on our list of priorities for StartOS (coming in v040). This will allow a number of services to have better interoperability with the broader Web. - -I'm having issues connecting to users or rooms in Matrix/Synapse, what can I do? --------------------------------------------------------------------------------- -Most issues in Matrix will be due to improper setup, or tor connectivity issues. Please follow the directions in the Synapse web interface closely, and be sure that you have a good tor connection on the device you are trying to connect with. As with all Tor addresses, make sure you are using http:// as a prefix (some apps will automatically prefix https://. - -Please reach out to support if you are still unable to connect. - -My Element desktop client stopped working after an OS update, what is happening? --------------------------------------------------------------------------------- -If you had to create a custom destkop shortcut, it is likely that this was reset with the system update, so you'll just need to remake it. This happens most often on Windows. - -I don't see an answer to my question regarding a certain service. Is there more documentation? ------------------------------------------------------------------------------------------------ -While we are intent on providing the most friendly experience possible to our customers, ultimately it will be impossible for Start9 to create documentation and tutorials for every service we make available on StartOS. Each service *should* have its own documentation produced by the service developers themselves, and we will do our best keep track, consolidate, and link to it in our :ref:`external support channels `. Also, much of the reason good tutorials don't exist is simply because no one in the community has taken the time to produce it. If you come across something useful or write something up yourself, please let us know and we will promote it. Otherwise we will do our best to answer questions as they arise and gradually build out tutorials where they are lacking. - -I want to understand in depth how a Service works and it's available configuration options. Where can I go to learn more? --------------------------------------------------------------------------------------------------------------------------- -Depending on the app, the config options can be quite involved. Bitcoin Core, for example, has an enormous amount of complex options, almost none of which are useful to a normal user doing normal things. We chose some very sane defaults that should work for normal use cases. Here is an example config from the Bitcoin `GitHub `_. - -By reading the descriptions in the link above, as well as doing some extra searching on your favorite search engine, you can begin to discover all the crazy ways in which someone can customize their Bitcoin node. Here is another list of `possible options `_. - -We translated much of (but not all of) the tons of options into a clean and easy-to-use GUI with toggles, dropdowns, inputs, etc, which is what you're seeing in your config screen. If you notice the little "?" icons on the left of each option, clicking them will provide a brief description as to what the option does. Also, our config GUI restricts the possible values you can enter such that you don't accidentally crash Bitcoin. That said, be very careful about just randomly changing things, lest your node starts to behave strangely. - -You can also check out our :ref:`Service Config Spec ` documentation for further details. diff --git a/site/source/support/faq/faq-startos.rst b/site/source/support/faq/faq-startos.rst deleted file mode 100644 index 0934ec2..0000000 --- a/site/source/support/faq/faq-startos.rst +++ /dev/null @@ -1,99 +0,0 @@ -.. _faq-startos: - -=========== -StartOS FAQ -=========== - -.. contents:: - :depth: 2 - :local: - -How is StartOS different from Umbrel? -------------------------------------- -Please see this :ref:`comparison page ` for a breakdown. - -Can I run StartOS on a VPS or VM? ---------------------------------- -Yes! The :ref:`DIY Guide ` has some details. Also check out our `Community Hub `_ to see guides and tips from Community members. - -Is it possible to use StartOS on my own hardware? -------------------------------------------------- -Yes! The :ref:`DIY Guide ` will take you through our guidelines. This option is great for people who already own some hardware or who live outside the US and want to save on shipping and customs fees. - -Additionally, StartOS is available for you to download or build from source under the Start9 Personal Use `License `_, for free. The caveat is that you will miss out on the perks that come along with purchasing from us, such as white-glove support, and others, which will grow over time. - -Do I plug my Start9 server into my computer? --------------------------------------------- -No. Your Start9 server only needs to be plugged into power and internet, just like your router. You can set it up right by your router and, similar to a router, generally forget about it - as all access is via your other devices. - -Do I plug in a monitor, keyboard, and mouse? --------------------------------------------- -Typically, no. It is not necessary or recommended to do this as StartOS runs in "headless" mode by default - meaning that you will access it from your computer or mobile device. However, we have recently added "Kiosk" mode, which allows the installation (and use) of StartOS with a monitor/keyboard/mouse. - -How much storage does a Start9 server have? -------------------------------------------- -Currently, Start9 servers ship with 128/256GB SD cards (Server Lite) and 1/2/4TB SSDs (Server One & Pure), but you may use a larger drive if you prefer. We advise **against** HDDs at this time for perfomance reasons. - -Are my Internet requests anonymous and secure? ----------------------------------------------- -StartOS and every service on our Marketplace serve their own Tor Hidden Services with unique Tor addresses. The private keys used to create these addresses are generated on your phone or computer when you first set up StartOS. No one, not even Start9, has any idea what your Tor addresses are, let alone the password(s) you choose to authenticate with them. - -Does Start9 have access to my personal Start9 server's encryption keys? ------------------------------------------------------------------------ -No. Your keys are generated on your device using the password you create so we CAN NOT, nor would we like to, see your private keys. - -Can multiple Start9 servers be setup to run redundantly in physically separate locations? ------------------------------------------------------------------------------------------ -Currently no, but we have plans for a feature that will enable StartOS to provide encrypted, automated backups across multiple servers. You can however, run as many servers as you'd like, copying data manually to each. - -How does StartOS compare to other Bitcoin nodes or personal servers? --------------------------------------------------------------------- -The cheapest way to run a Bitcoin/Lightning node is to buy a Raspberry Pi (or equivalent), download or compile Bitcoin, LND/CLN, etc, and host everything on Tor. This takes even technical people significant time to accomplish. On the other end of the spectrum is something like StartOS, which "just works". In between is stuff like MyNode, Nodl, RoninDojo, Umbrel, and Raspiblitz, which all require some degree of command line effort and manual configuration. The biggest benefit of StartOS is that it is infinitely extensible to all of open-source, self-hosted software. The service listing will expand enormously over time in ways the other platforms may choose not to, or have difficulty implementing. - -Would you consider (Umbrel, Nodl, RoninDojo, etc) a competitor to StartOS, or are they different enough to be compatible? --------------------------------------------------------------------------------------------------------------------------- -Other node devices are competitors, and there are distinct trade-offs to each platform, but we are definitely moving toward the same future, which is a win for everyone! - -One difference with Start9 is that we began with a plan to create an OS for general-purpose sovereign hosting of server-side software. No other project in this space (that we know of) started this way. There's also no reason you can't use more than one device. As an example, some users prefer StartOS for their data and RoninDojo for their Bitcoin stack. - -Some other things that StartOS offers that others do not: - -- Graphical configuration of services (instead of command line) -- System backups (pretty important) -- Encrypted connection over the home network (https) -- Health Checks for quick-glance understanding of the status of your services -- Unique user experiences created by service-packagers, including "Actions" (custom commands at the click of a button!) - -From an architectural perspective, StartOS is a true operating system (of the Linux flavor), giving you the ability to understand and control what is going on. Many other systems are black boxes offering little insight or agency to you. If something goes wrong, you'll have to put in your engineer hat and go command line diving. Lastly, our team is very responsive and helpful. We pride ourselves on providing incredible customer support and education. - -How can I migrate from MyNode/Raspiblitz/Umbrel to StartOS and keep my lightning channels intact? -------------------------------------------------------------------------------------------------- -We've created a guide to help you `transform your Umbrel's bitcoin stack into a Start9 server `_. - -Alternatively, if you have an Umbrel and a Start9 server and they're on the same network, you can just select *Services > Lightning Network Daemon > Actions > Import from Umbrel* in your Start9 server's web interface and your LND settings and channels will be automatically migrated. - -As of LND v0.16.4, similar Actions are available for MyNode and Raspiblitz. - -Can I mine Bitcoin with this? ------------------------------ -You do **not** want to do that. Mining equipment is highly specialized, and this is not that. - -Does StartOS only work over Tor? No http or VPN? -------------------------------------------------- -Your server's services are currently primarily accessible over Tor. In many cases we use HTTP over Tor (they are not mutually exclusive), you can see this by navigating to the Tor address in a browser and see the “http” in front of it. Further networking options (and massive flexibility) are coming with StartOS v040. You can also connect directly via LAN if you are on the same network as your device. - -Which network traffic travels over tor and which does not? ----------------------------------------------------------- -In StartOS versions previous to v040, inbound connections can only be **initiated** over tor. Clearnet (IP) connections can be initiated outbound by the OS (in the case of OS updates or accessing the Start9 Marketplace), or by services (such as by Bitcoin when connecting to the Bitcoin p2p network). In many cases, it is possible to operate **only** via tor by configuring a particular service to do so. For example, in the Bitcoin config, you can "Disable Clearnet" connections, or remove your node from the public network entirely. - -Following StartOS v040, powerful and flexible networking configs will be possible across the system. - -What if someone gets physical access to my device, can they read the contents? Is it encrypted? ------------------------------------------------------------------------------------------------ -The data is currently encrypted at rest, but not in a way that would prevent a sophisticated attacker from accessing it. This is a step towards better security in the near future. At-rest encryption on servers is a serious challenge, because of the need for remote availability. For example, you may not be at home to enter an encryption password following a power outage, leaving you without access to your server. - -Services like Vaultwarden, however, encrypt all user data, so your passwords will not be compromised unless they know your master password. - -Why http and not https for .onion websites? -------------------------------------------- -When visiting a Tor V3 URL (.onion website), your communications are end-to-end encrypted and onion-routed by default. There is no added benefit to using https. See this `article `_ from the Tor Project for more details. You will notice that some services implement ``https`` for client compatibility reasons, however. diff --git a/site/source/support/faq/faq-troubleshooting.rst b/site/source/support/faq/faq-troubleshooting.rst deleted file mode 100644 index 4285329..0000000 --- a/site/source/support/faq/faq-troubleshooting.rst +++ /dev/null @@ -1,65 +0,0 @@ -.. _faq-troubleshooting: - -============================= -Setup and Troubleshooting FAQ -============================= - -.. contents:: - :depth: 2 - :local: - -What do I do first? -------------------- -Please check out the :ref:`Initial Setup ` page, and follow the instructions. - -How do I know if my server is running? --------------------------------------- -After plugging into power and your router, if your device is equipped with a speaker, you will hear 2 distinct sounds: first, a “bep” ‐ indicating the device is powering on, and second, a “chime” ‐ indicating the device is ready for setup. You can hear these sounds on the :ref:`Initial Setup` page. Otherwise, your server is available on its unique ``adjective-noun.local`` or ``onion`` addresses. If something goes wrong, it will serve a diagnostic page on ``http://start.local``. - -My server is really hot! Is this normal? ------------------------------------------ -On early devices, yes. These cases are actually doing 'double duty' as a heat sink. This means that the metal of the case is actually touching the chips on the circuit board and drawing their heat out and away. This is known as "passive cooling," as no fan (and therefore no noise) is required to cool the system. - -You can check the chip temperature of your device under "System -> Metrics". - -I cannot reach start.local (for setup) after hearing the start-up sounds. What do I do? ----------------------------------------------------------------------------------------- -* Ensure that you are on the same network as your server. Check that it is not a "Guest" network in your router -* Your browser might try to force https://start.local, delete the https:// prefix and try again with just start.local or http://start.local -* Try a different browser, and note that Tor Browser cannot handle .local addresses -* Turn off your VPN if you are using one (you may turn it back on after setup), or "allow LAN connections" if your VPN has such a setting. -* If none of the above work, check your network setup, including your router settings if they are non-standard - -.. _why-bonjour: - -Why do I need the Bonjour service (Windows)? --------------------------------------------- -A major use-case of Bonjour is wireless printing over the LAN, but your Windows machine can also use Bonjour to discover and connect with other devices on the :ref:`Local Network`. In this case your Start9 server. If Windows were to add support for reaching ``.local`` addresses, as is done in Linux and Mac, this would no longer be necessary. - -This dependency will no longer be required following StartOS v040. - -My Tor sites aren't loading, what should I do? ----------------------------------------------- -This is most likely a transient networking issue that will correct itself in a few minutes to an hour. If it does not, there are few things you can try: - -1. On Android/Orbot, the most common solution is to restart your Android device. - -2. Access your server over :ref:`LAN `, and restart Tor from the "System" -> "Experimental Features" section. - -3. Restart your server. - -4. Restart your router. - -Do I need to take any additional security precautions with my device, for example with my router/modem? -------------------------------------------------------------------------------------------------------- -Nothing special is required, however, it is best practice to use good passwords, i.e. for your WiFi and your server. Here's a `comic `_ explaining how to make strong passwords, simply. Bitwarden clients also all contain feature-rich password generation tools. - -What if I have an unique network issue, for example, with a firewall? ---------------------------------------------------------------------- -StartOS is designed to work as simply as possible, for as many as possible, while providing the ability to host in a private manner. If you have an aggressive or custom firewall, or other custom network settings, there is a good chance that addtional configuration may be necessary. We will continue to learn about custom networking issues, update our docs with resources, and help in the `Community Channels `_ to the best of our ability. - -Can I use my server from behind a VPN, for example, if my router has a built-in VPN? ------------------------------------------------------------------------------------- -Yes, this is possible, but it adds complexity, which may lead to problems. You will need to understand the setup of your router/VPN and how it supports (or doesn't support) Tor/LAN connections. - -If you are having trouble with this, you might consider letting your server out "in the clear," since all services are accessible over the Tor network, offering a high level of privacy. Obviously, Start9 cannot support every variation of router and network. diff --git a/site/source/support/faq/index.rst b/site/source/support/faq/index.rst deleted file mode 100644 index 7814f5f..0000000 --- a/site/source/support/faq/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _faq: - -=== -FAQ -=== - -Answers to Frequently Asked Questions - -.. toctree:: - :maxdepth: 2 - - faq-general - faq-startos - faq-basic-use - faq-troubleshooting - faq-contributing - faq-bitcoin - faq-lightning - faq-services - faq-service-packaging - umbrel-compare \ No newline at end of file diff --git a/site/source/support/faq/umbrel-compare.rst b/site/source/support/faq/umbrel-compare.rst deleted file mode 100644 index 0ddb33e..0000000 --- a/site/source/support/faq/umbrel-compare.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. _umbrel-compare: - -================= -Umbrel Comparison -================= - -.. contents:: - :depth: 2 - :local: - -By popular demand, Start9 has provided a brief comparison between StartOS and Umbrel. - -How are they similar? ---------------------- -Both Umbrel and StartOS dramatically simplify the process of discovering, downloading, and installing services onto a private server, and that is about where the similarities end. - -How are they different? ------------------------ - -Appearance -========== -Umbrel uses MacOS's aesthetic. The user interface is clean, colorful, and customizable. StartOS offers a functional design with little color or customization. - -Services -======== -As of June 1, 2023, there are approximately 100 services available for Umbrel, and 40 services available for StartOS. Both offer developer docs that permit anyone anywhere to package anything, and neither is capable of gatekeeping. - -Architecture -============ -Umbrel itself is an *app* that can be *installed* onto most Debian or Ubuntu computers and virtual machines. StartOS is an *operating system* (Linux distro) that can be *flashed* onto most computers and virtual machines. - -Config -====== -Services often provide config files, such as Bitcoin's ``bitcoin.conf``. On Umbrel, updating config files requires using SSH and the command line. With StartOS, config files are presented as rich forms, including descriptions, dropdowns, toggles, validated inputs, etc. - -Backups -======= -When it comes to self-hosting, nothing is more important than making backups. With the exception of LND, Umbrel does not provide a means of backing up services. With StartOS, encrypted backups can be made by pushing a button. - -Encryption -========== -On Umbrel, communications over the LAN are done over plain http. This means that anyone connected to your home WiFi network can trivially steal your passwords and money. With StartOS, communications over the LAN are done over encrypted https. - -Monitoring -========== -Umbrel does not provide tools for monitoring the health or performance of services. SSH and the command line are needed to view service logs. StartOS offers custom health checks that display service health, and a live screen for viewing service logs. - -DIY Options -=========== -Both Umbrel and StartOS can be installed for free. As an app, Umbrel can only be installed on the Raspberry Pi and devices running Debian or Ubuntu. As an operating system, StartOS can be installed on just about any computer or virtual machine. - -Pricing -======= -Both companies offer plug and play devices. Umbrel offers a single device for $700. It has a 2.0GHz processor, 16GB of RAM, and a 2TB NVMe SSD. Start9 offers a similar device for $563. - -Start9 also has other options ranging from $199 to $1546. diff --git a/site/source/support/index.rst b/site/source/support/index.rst index c26bf9e..2e84ef0 100644 --- a/site/source/support/index.rst +++ b/site/source/support/index.rst @@ -22,7 +22,7 @@ View frequently asked questions, troubleshoot common issues, or contact support. .. topic-box:: :title: FAQ - :link: faq + :link: https://start9.com/faq :icon: scylla-icon scylla-icon--monitoring :class: large-5 :anchor: View @@ -57,6 +57,5 @@ View frequently asked questions, troubleshoot common issues, or contact support. :hidden: common-issues - faq/index concepts/index external-support diff --git a/site/source/user-manual/backup-restore/backup-create.rst b/site/source/user-manual/backup-restore/backup-create.rst deleted file mode 100644 index b1745ab..0000000 --- a/site/source/user-manual/backup-restore/backup-create.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. _backup: - -====== -Backup -====== -Backing up your server is easy and secure. Backups are encrypted with your master password. - -.. contents:: - :depth: 2 - :local: - -.. tip:: Create frequent backups to keep your data safe! - -Setup Device ------------- -Select your platform for detailed instructions on how to create a Network Folder for creating backups. This can include a drive in, or attached to, a device on your network. Otherwise, you may backup directly to a :ref:`physical drive`, attached to your server. - - * :ref:`Linux Network Folder ` - - * :ref:`Mac Network Folder ` - - * :ref:`Windows Network Folder ` - - * :ref:`Synology Network Folder ` - - * :ref:`TrueNAS Network Folder ` - - * :ref:`Physical Drive ` - -.. _backup-create: - -Create Backup -------------- -#. Go to *System > Create Backup* - - .. figure:: /_static/images/config/backup.png - :width: 60% - -#. You will see your previously created Network Folder backup location (or Physical Drive) available. Click it, select the services you wish to backup, then click "**BACK UP SELECTED**": - - .. figure:: /_static/images/config/backup2.png - :width: 60% - -#. You will be prompted for your server's master password: - - .. figure:: /_static/images/config/backup2.5.png - :width: 60% - -#. The backup will begin. You can continue to use your server while the backup is in progress. - - .. figure:: /_static/images/config/backup3.png - :width: 60% - -#. When the backup is complete, you will receive a notification where a detailed report is available. - - .. figure:: /_static/images/config/backup4.png - :width: 60% - -#. If successful, you will also see the date and time of your most recent backup under **BACKUPS** in the **System** tab: - - .. figure:: /_static/images/config/backup5.png - :width: 60% \ No newline at end of file diff --git a/site/source/user-manual/backup-restore/backup-physical.rst b/site/source/user-manual/backup-restore/backup-physical.rst deleted file mode 100644 index de70ff6..0000000 --- a/site/source/user-manual/backup-restore/backup-physical.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. _backup-physical: - -======================== -Backup to Physical Drive -======================== -.. tip:: Create frequent backups to avoid loss of data! - -.. youtube:: KJRO9wGOOVw - :width: 100% - -The recommended method of backup (including with external drives) is to setup a :ref:`Network Folder` via your OS. However, you may use an external drive plugged directly into your server. - -.. warning:: If you are using a low-powered device (like a RasPi), this drive MUST have external power, or be connected via a powered USB hub in order to prevent any data corruption due to power constraints! Server One and Server Pure users can safely ignore this warning. - -#. Ensure your backup drive is properly formatted. The recommended format at this time is ``exFAT``. **Do not** use ``fat32``. - -#. If your drive is self-powered, you can plug it directly into your Start9 server blue USB 3.0 slot. If not, first plug the drive into a powered USB hub, then plug the hub into your Start9 server. Then you may power it up. - -#. Go to *System > Create Backup* - - .. figure:: /_static/images/config/backup.png - :width: 60% - -#. Select your drive. - - .. figure:: /_static/images/config/physical-backup1.png - :width: 60% - - .. figure:: /_static/images/config/physical-backup2.png - :width: 60% - -#. Enter your StartOS master password. - - .. figure:: /_static/images/config/backup3.png - :width: 60% - -#. When the backup is complete, you will receive a notification. If successful, you will see the date and time of your most recent backup updated under "Backups" in the System tab. - - .. figure:: /_static/images/config/backup4.png - :width: 60% diff --git a/site/source/user-manual/backups/backup-create.rst b/site/source/user-manual/backups/backup-create.rst new file mode 100644 index 0000000..2fb4ec9 --- /dev/null +++ b/site/source/user-manual/backups/backup-create.rst @@ -0,0 +1,69 @@ +.. _backup-create: + +============= +Backup Create +============= + +Choose your backup target +------------------------- + +You can back up your data to a physical drive plugged into the server, or over-the-air to a network folder shared from another device on the same LAN. + +Physical Drive +.............. + +#. Ensure your backup drive is properly formatted. The recommended format at this time is ``exFAT``. **Do not** use ``fat32``. + +#. Plug your physical drive into your server. + + .. warning:: If you are using a low-powered device (like a RasPi), this drive MUST have external power, or be connected via a powered USB hub in order to prevent any data corruption due to power constraints! Server One and Server Pure users can safely ignore this warning. + + +Network Folder +.............. + +Choose your destination platform below for instructions on creating and sharing a network folder. + + * :ref:`Linux ` + + * :ref:`Mac ` + + * :ref:`Windows ` + + * :ref:`Synology ` + + * :ref:`TrueNAS ` + + +Create the Backup +----------------- + +#. Go to *System > Create Backup* + + .. figure:: /_static/images/config/backup.png + :width: 60% + +#. Select the network folder or physical drive you want to target, then select the services you want to back up. + + .. figure:: /_static/images/config/backup2.png + :width: 60% + +#. You will be prompted for your server's master password. + + .. figure:: /_static/images/config/backup2.5.png + :width: 60% + +#. The backup will begin. You can continue to use your server while the backup is in progress. + + .. figure:: /_static/images/config/backup3.png + :width: 60% + +#. When the backup is complete, you will receive a notification where a detailed report is available. + + .. figure:: /_static/images/config/backup4.png + :width: 60% + +#. If successful, you will also see the date and time of your most recent backup under **BACKUPS** in the **System** tab: + + .. figure:: /_static/images/config/backup5.png + :width: 60% \ No newline at end of file diff --git a/site/source/user-manual/backup-restore/backup-restore.rst b/site/source/user-manual/backups/backup-restore.rst similarity index 90% rename from site/source/user-manual/backup-restore/backup-restore.rst rename to site/source/user-manual/backups/backup-restore.rst index 391fa54..6047508 100644 --- a/site/source/user-manual/backup-restore/backup-restore.rst +++ b/site/source/user-manual/backups/backup-restore.rst @@ -1,8 +1,8 @@ .. _backup-restore: -======= -Restore -======= +============== +Backup Restore +============== There are 3 different ways that you may choose to recover server data, as well as a 4th option to migrate/transfer data between hardware. @@ -11,7 +11,7 @@ There are 3 different ways that you may choose to recover server data, as well a #. "Restore [entire server] from Backup" (as in, disaster recovery) all server data in the event that your backup is the **only** thing you have left. #. "Transfer" data from an existing server. This is a total migration for use when upgrading hardware only. -.. warning:: If you are restoring data from a drive that you are attaching *directly to your server,* (if using a RasPi or other low-powered board) please ensure that it is getting adequate power. This is best accomplished via external power to the drive (such as a powered USB hub). Server One (2022 and newer) and Server Pro users can safely ignore this warning. +.. warning:: If you are restoring data from a drive that you are attaching *directly to your server,* (if using a RasPi or other low-powered board) please ensure that it is getting adequate power. This is best accomplished via external power to the drive (such as a powered USB hub). Server One (2022 and newer) and Server Pure users can safely ignore this warning. Select the appropriate tab below to restore your data: @@ -45,22 +45,22 @@ Select the appropriate tab below to restore your data: #. During :ref:`Initial Setup`, select "Recover." - .. figure:: /_static/images/setup/screen0-startfresh_or_recover.png + .. figure:: /_static/images/setup/screen0-recover.jpg :width: 60% #. Next, select "Use Existing Drive." - .. figure:: /_static/images/setup/screen3-use_existing.png + .. figure:: /_static/images/setup/screen3-use_existing.jpg :width: 60% #. Select your server's data drive. - .. figure:: /_static/images/setup/screen4-use_existing_drive_selection.png + .. figure:: /_static/images/setup/screen4-use_existing_drive_selection.jpg :width: 60% #. Enter and confirm a new password. - .. figure:: /_static/images/setup/screen5-set_password.jpg + .. figure:: /_static/images/setup/screen5-set_password_complete.jpg :width: 60% #. Your server will initialize again (all previous data will be recovered). @@ -72,7 +72,7 @@ Select the appropriate tab below to restore your data: #. During :ref:`Initial Setup`, select "Recover." - .. figure:: /_static/images/setup/screen0-startfresh_or_recover.png + .. figure:: /_static/images/setup/screen0-recover.jpg :width: 60% #. Select "Restore From Backup." @@ -85,7 +85,7 @@ Select the appropriate tab below to restore your data: .. figure:: /_static/images/restore/recover1.png :width: 60% - #. Enter the details for your Network Folder and click "Verify." Check the appropriate :ref:`backup setup page` for reference if you are unsure of the parameters. + #. Enter the details for your Network Folder and click "Verify". .. figure:: /_static/images/restore/recover2.png :width: 60% @@ -97,7 +97,7 @@ Select the appropriate tab below to restore your data: #. Select the drive (from your new hardware) that you are recovering onto. - .. warning:: This will **PERMANENETLY ERASE** any existing data on that drive. If you re-using an old drive, ensure that you have first removed all your data!! + .. warning:: This will **PERMANENTLY ERASE** any existing data on that drive. If you re-using an old drive, ensure that you have first removed all your data!! .. figure:: /_static/images/restore/recover4.png :width: 60% @@ -114,7 +114,7 @@ Select the appropriate tab below to restore your data: #. During :ref:`Initial Setup`, select "Recover." - .. figure:: /_static/images/setup/screen0-startfresh_or_recover.png + .. figure:: /_static/images/setup/screen0-recover.jpg :width: 60% #. Select "Transfer" diff --git a/site/source/user-manual/backup-restore/index.rst b/site/source/user-manual/backups/index.rst similarity index 68% rename from site/source/user-manual/backup-restore/index.rst rename to site/source/user-manual/backups/index.rst index 4be8191..7ea3142 100644 --- a/site/source/user-manual/backup-restore/index.rst +++ b/site/source/user-manual/backups/index.rst @@ -3,6 +3,7 @@ ======= Backups ======= + In addition to the safe-keeping of a good master password, maintaining good backups is the major responsibility required to keep the benefits and freedom that come with self-hosting. .. raw:: html @@ -12,7 +13,7 @@ In addition to the safe-keeping of a good master password, maintaining good back
.. topic-box:: - :title: Create Backup + :title: Backup Create :link: backup-create :icon: scylla-icon scylla-icon--cloud :class: large-5 @@ -21,7 +22,7 @@ In addition to the safe-keeping of a good master password, maintaining good back Create an encrypted backup of your server data. .. topic-box:: - :title: Restore From Backup + :title: Backup Restore :link: backup-restore :icon: scylla-icon scylla-icon--live-test :class: large-5 @@ -29,15 +30,6 @@ In addition to the safe-keeping of a good master password, maintaining good back Restore your server data from a previous backup. -.. topic-box:: - :title: Advanced Backup Tools - :link: backup-advanced - :icon: scylla-icon scylla-icon--live-test - :class: large-5 - :anchor: View - - Tools for backups - use only at the direction of support, or at your own risk. - .. raw:: html
@@ -48,7 +40,3 @@ In addition to the safe-keeping of a good master password, maintaining good back backup-create backup-restore - backup-physical - backup-synology - backup-truenas - backup-advanced diff --git a/site/source/user-manual/index.rst b/site/source/user-manual/index.rst index 0b94610..643c30f 100644 --- a/site/source/user-manual/index.rst +++ b/site/source/user-manual/index.rst @@ -11,7 +11,7 @@ User Manual dashboard-overview change-password managing-services - backup-restore/index + backups/index customize updating sessions