From e4aa890674b654b27d64267ac7d21dfee4a4724f Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Wed, 29 Dec 2021 08:09:42 -0700 Subject: [PATCH] Another menu refactor, backups init --- poetry.lock | 12 +-- site/source/about/index.rst | 88 +++++++++++++++--- site/source/contribute/index.rst | 86 +++++++++++++++--- site/source/index.rst | 14 +-- site/source/learn/index.rst | 69 +++++++++++--- .../learn/media/{news.rst => articles.rst} | 0 site/source/learn/media/index.rst | 4 +- site/source/support/index.rst | 89 +++++++++++++++---- .../user-manual/walkthrough/backup.rst | 57 ------------ .../walkthrough/backup/backup-lin.rst | 38 ++++++++ .../walkthrough/backup/backup-mac.rst | 30 +++++++ .../walkthrough/backup/backup-win.rst | 30 +++++++ .../user-manual/walkthrough/backup/index.rst | 14 +++ .../support/user-manual/walkthrough/index.rst | 2 +- 14 files changed, 405 insertions(+), 128 deletions(-) rename site/source/learn/media/{news.rst => articles.rst} (100%) delete mode 100644 site/source/support/user-manual/walkthrough/backup.rst create mode 100644 site/source/support/user-manual/walkthrough/backup/backup-lin.rst create mode 100644 site/source/support/user-manual/walkthrough/backup/backup-mac.rst create mode 100644 site/source/support/user-manual/walkthrough/backup/backup-win.rst create mode 100644 site/source/support/user-manual/walkthrough/backup/index.rst diff --git a/poetry.lock b/poetry.lock index 1018e3c..4731824 100644 --- a/poetry.lock +++ b/poetry.lock @@ -24,17 +24,17 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "attrs" -version = "21.4.0" +version = "21.3.0" description = "Classes Without Boilerplate" category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" [package.extras] -dev = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface", "furo", "sphinx", "sphinx-notfound-page", "pre-commit", "cloudpickle"] +dev = ["cloudpickle", "coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface", "furo", "sphinx", "sphinx-notfound-page", "pre-commit"] docs = ["furo", "sphinx", "zope.interface", "sphinx-notfound-page"] -tests = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface", "cloudpickle"] -tests_no_zope = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "cloudpickle"] +tests = ["cloudpickle", "coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface"] +tests_no_zope = ["cloudpickle", "coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins"] [[package]] name = "babel" @@ -633,8 +633,8 @@ atomicwrites = [ {file = "atomicwrites-1.4.0.tar.gz", hash = "sha256:ae70396ad1a434f9c7046fd2dd196fc04b12f9e91ffb859164193be8b6168a7a"}, ] attrs = [ - {file = "attrs-21.4.0-py2.py3-none-any.whl", hash = "sha256:2d27e3784d7a565d36ab851fe94887c5eccd6a463168875832a1be79c82828b4"}, - {file = "attrs-21.4.0.tar.gz", hash = "sha256:626ba8234211db98e869df76230a137c4c40a12d72445c45d5f5b716f076e2fd"}, + {file = "attrs-21.3.0-py2.py3-none-any.whl", hash = "sha256:8f7335278dedd26b58c38e006338242cc0977f06d51579b2b8b87b9b33bff66c"}, + {file = "attrs-21.3.0.tar.gz", hash = "sha256:50f3c9b216dc9021042f71b392859a773b904ce1a029077f58f6598272432045"}, ] babel = [ {file = "Babel-2.9.1-py2.py3-none-any.whl", hash = "sha256:ab49e12b91d937cd11f0b67cb259a57ab4ad2b59ac7a3b41d6c06c0ac5b0def9"}, diff --git a/site/source/about/index.rst b/site/source/about/index.rst index 9b7735e..853914d 100644 --- a/site/source/about/index.rst +++ b/site/source/about/index.rst @@ -1,20 +1,80 @@ -.. _knowledge-base: +.. _about: -============== -Knowledge Base -============== +.. title:: About Start9 Labs +.. raw:: html + +
+ +.. hero-box:: + :title: About Start9 Labs + :button_icon: scylla-icon scylla-icon--monitoring + :image: /_static/img/eos_0.3.0.png + + Here you will find out how to join the community and give back! + +.. raw:: html + +
+ +.. raw:: html + +
+ +
+ +.. topic-box:: + :title: Teach + :link: teach + :icon: scylla-icon scylla-icon--knowledge-base + :class: large-4 + :anchor: Learn + + An overview of the ideas and technologies surrounding Start9 Labs and Embassy. + +.. topic-box:: + :title: Provide Support + :link: provide-support + :icon: scylla-icon scylla-icon--knowledge-base + :class: large-4 + :anchor: Learn + + An overview of the ideas and technologies surrounding Start9 Labs and Embassy. + +.. topic-box:: + :title: Decentralize + :link: decentralize + :icon: scylla-icon scylla-icon--knowledge-base + :class: large-4 + :anchor: Learn + + An overview of the ideas and technologies surrounding Start9 Labs and Embassy. + +.. topic-box:: + :title: Promote + :link: promote + :icon: scylla-icon scylla-icon--knowledge-base + :class: large-4 + :anchor: Learn + + An overview of the ideas and technologies surrounding Start9 Labs and Embassy. + +.. raw:: html + +
+ +.. raw:: html + +
+ +.. This is for the side navigation display .. toctree:: :maxdepth: 2 :hidden: - concepts/index - faq/index - -.. panel-box:: - :title: Overview - :id: "knowledge-base" - :class: my-panel - - * :doc:`Concepts ` - An overview of the ideas and technologies surrounding Start9 Labs and Embassy. - * :doc:`FAQ ` - Answers to Frequently Asked Questions from Embassy users. + start9 + roadmap + privacy + license + jobs + contact diff --git a/site/source/contribute/index.rst b/site/source/contribute/index.rst index 9b7735e..c3c8e28 100644 --- a/site/source/contribute/index.rst +++ b/site/source/contribute/index.rst @@ -1,20 +1,78 @@ -.. _knowledge-base: +.. _contribute: -============== -Knowledge Base -============== +.. title:: Contribute +.. raw:: html + +
+ +.. hero-box:: + :title: Contribute + :button_icon: scylla-icon scylla-icon--monitoring + :image: /_static/img/eos_0.3.0.png + + Here you will find out how to join the community and give back! + +.. raw:: html + +
+ +.. raw:: html + +
+ +
+ +.. topic-box:: + :title: Teach + :link: teach + :icon: scylla-icon scylla-icon--knowledge-base + :class: large-4 + :anchor: Learn + + An overview of the ideas and technologies surrounding Start9 Labs and Embassy. + +.. topic-box:: + :title: Provide Support + :link: provide-support + :icon: scylla-icon scylla-icon--knowledge-base + :class: large-4 + :anchor: Learn + + An overview of the ideas and technologies surrounding Start9 Labs and Embassy. + +.. topic-box:: + :title: Decentralize + :link: decentralize + :icon: scylla-icon scylla-icon--knowledge-base + :class: large-4 + :anchor: Learn + + An overview of the ideas and technologies surrounding Start9 Labs and Embassy. + +.. topic-box:: + :title: Promote + :link: promote + :icon: scylla-icon scylla-icon--knowledge-base + :class: large-4 + :anchor: Learn + + An overview of the ideas and technologies surrounding Start9 Labs and Embassy. + +.. raw:: html + +
+ +.. raw:: html + +
+ +.. This is for the side navigation display .. toctree:: :maxdepth: 2 :hidden: - concepts/index - faq/index - -.. panel-box:: - :title: Overview - :id: "knowledge-base" - :class: my-panel - - * :doc:`Concepts ` - An overview of the ideas and technologies surrounding Start9 Labs and Embassy. - * :doc:`FAQ ` - Answers to Frequently Asked Questions from Embassy users. + teach + provide-support + decentralize + promote diff --git a/site/source/index.rst b/site/source/index.rst index 6dc5a9d..c9994b1 100644 --- a/site/source/index.rst +++ b/site/source/index.rst @@ -32,7 +32,7 @@ .. topic-box:: :title: Build your own - :link: user-manual/tuning/diy + :link: support/user-manual/tuning/diy :icon: scylla-icon scylla-icon--integrations :class: large-4 :anchor: Get started @@ -50,7 +50,7 @@ .. topic-box:: :title: User Manual - :link: user-manual + :link: support/user-manual :icon: scylla-icon scylla-icon--knowledge-base :class: large-6 :anchor: View @@ -59,7 +59,7 @@ .. topic-box:: :title: Support - :link: knowledge-base/faq + :link: support :icon: scylla-icon scylla-icon--support :class: large-6 :anchor: Get help @@ -68,7 +68,7 @@ .. topic-box:: :title: Learn - :link: knowledge-base/faq + :link: learn :icon: scylla-icon scylla-icon--webinars :class: large-3 :anchor: Get started @@ -77,7 +77,7 @@ .. topic-box:: :title: SDK - :link: dev-docs + :link: support/dev-docs :icon: scylla-icon scylla-icon--open-source :class: large-3 :anchor: View @@ -86,7 +86,7 @@ .. topic-box:: :title: Contribute - :link: dev-docs/dev-faq/faq-contributing + :link: contribute :icon: scylla-icon scylla-icon--networking :class: large-3 :anchor: Join us @@ -117,4 +117,4 @@ user-manual/index knowledge-base/index - dev-docs/index \ No newline at end of file + dev-docs/index diff --git a/site/source/learn/index.rst b/site/source/learn/index.rst index 9b7735e..e4aba5b 100644 --- a/site/source/learn/index.rst +++ b/site/source/learn/index.rst @@ -1,20 +1,67 @@ .. _knowledge-base: -============== -Knowledge Base -============== +.. title:: Knowledge Base +.. raw:: html + +
+ +.. hero-box:: + :title: Learn + :button_icon: scylla-icon scylla-icon--monitoring + :image: /_static/img/eos_0.3.0.png + + Here you will find information on concepts that will help you understand the technologies used by and relevant to your device, as well as find answers to common questions, and a video library with a wide array of content, from educational to how-to. + +.. raw:: html + +
+ +.. raw:: html + +
+ +
+ +.. topic-box:: + :title: Concepts + :link: concepts/index + :icon: scylla-icon scylla-icon--knowledge-base + :class: large-4 + :anchor: Learn + + An overview of the ideas and technologies surrounding Start9 Labs and Embassy. + +.. topic-box:: + :title: FAQ + :link: faq/index + :icon: scylla-icon scylla-icon--monitoring + :class: large-4 + :anchor: Get Answers + + Answers to Frequently Asked Questions from Embassy users. + +.. topic-box:: + :title: Videos + :link: https://youtube.com/c/Start9 + :icon: scylla-icon scylla-icon--monitoring + :class: large-4 + :anchor: Watch + + Our video archives, with educational content, including how-tos and DIY guides. + +.. raw:: html + +
+ +.. raw:: html + +
+ +.. This is for the side navigation display .. toctree:: :maxdepth: 2 :hidden: concepts/index faq/index - -.. panel-box:: - :title: Overview - :id: "knowledge-base" - :class: my-panel - - * :doc:`Concepts ` - An overview of the ideas and technologies surrounding Start9 Labs and Embassy. - * :doc:`FAQ ` - Answers to Frequently Asked Questions from Embassy users. diff --git a/site/source/learn/media/news.rst b/site/source/learn/media/articles.rst similarity index 100% rename from site/source/learn/media/news.rst rename to site/source/learn/media/articles.rst diff --git a/site/source/learn/media/index.rst b/site/source/learn/media/index.rst index 9b7735e..b4bc0cf 100644 --- a/site/source/learn/media/index.rst +++ b/site/source/learn/media/index.rst @@ -8,8 +8,8 @@ Knowledge Base :maxdepth: 2 :hidden: - concepts/index - faq/index + articles + podcasts .. panel-box:: :title: Overview diff --git a/site/source/support/index.rst b/site/source/support/index.rst index 9b7735e..7acc034 100644 --- a/site/source/support/index.rst +++ b/site/source/support/index.rst @@ -1,20 +1,77 @@ -.. _knowledge-base: +.. _support: -============== -Knowledge Base -============== +.. title:: Support +.. raw:: html + +
+ +.. hero-box:: + :title: Get Help + :button_icon: scylla-icon scylla-icon--monitoring + :image: /_static/img/eos_0.3.0.png + + Here you will find help on how to use your devices, answers to frequently asked questions, and documentation for developers. + +.. raw:: html + +
+ +.. raw:: html + +
+ +
+ +.. topic-box:: + :title: User Manual + :link: user-manual/index + :icon: scylla-icon scylla-icon--knowledge-base + :class: large-4 + :anchor: View + + All you need to be an owner/operator of your own self-hosted software + +.. topic-box:: + :title: FAQ + :link: faq/index + :icon: scylla-icon scylla-icon--monitoring + :class: large-4 + :anchor: Get Answers + + Answers to Frequently Asked Questions from Embassy users. + +.. topic-box:: + :title: Developer Documentation + :link: dev-docs/index + :icon: scylla-icon scylla-icon--open-source + :class: large-4 + :anchor: Build + + Tools and guides for developers + +.. topic-box:: + :title: Community Channels + :link: dev-docs/index + :icon: scylla-icon scylla-icon--networking + :class: large-4 + :anchor: Join us + + Network with the community to get help and offer your skills and insights to the cause! + +.. raw:: html + +
+ +.. raw:: html + +
+ +.. This is for the side navigation display .. toctree:: - :maxdepth: 2 - :hidden: + :maxdepth: 2 + :hidden: - concepts/index - faq/index - -.. panel-box:: - :title: Overview - :id: "knowledge-base" - :class: my-panel - - * :doc:`Concepts ` - An overview of the ideas and technologies surrounding Start9 Labs and Embassy. - * :doc:`FAQ ` - Answers to Frequently Asked Questions from Embassy users. + user-manual/index + faq/index + dev-docs/index diff --git a/site/source/support/user-manual/walkthrough/backup.rst b/site/source/support/user-manual/walkthrough/backup.rst deleted file mode 100644 index b3b3409..0000000 --- a/site/source/support/user-manual/walkthrough/backup.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. _backup: - -================== -Backing Up Embassy -================== - -There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop or desktop, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy. - -Remote Backups --------------- - -Linux -===== - - #. IYKYK - -Mac -=== - - #. go to system settings - #. click sharing - #. click file sharing - #. click the + under shared folders - #. add a folder - #. click options - #. enable Windows file sharing for the user you would like to use to authenticate - #. click done - #. enter the name of your macbook, as shown in the computer name field at the top of the sharing page into the hostname field in embassy ui - #. enter the name of the folder as shown in the shared folders section as the path - #. enter your macbook username and password for the user that you enabled windows file sharing for - -Windows -======= - - #. Create a folder - #. Right click the folder - #. select "properties" - #. click the share tab - #. click share... - #. select a user you want to use for login, or select everyone - #. click share - #. enter your computer name into the hostname field in embassy ui (the name is shown after a \\ in the windows ui) - #. enter the path that is shown after the hostname in the windows ui into the path field - #. enter your username for the windows computer - #. enter the password for the windows computer - -Local Backups -------------- - -Linux -===== - -Mac -=== - -Windows -======= diff --git a/site/source/support/user-manual/walkthrough/backup/backup-lin.rst b/site/source/support/user-manual/walkthrough/backup/backup-lin.rst new file mode 100644 index 0000000..10fa87f --- /dev/null +++ b/site/source/support/user-manual/walkthrough/backup/backup-lin.rst @@ -0,0 +1,38 @@ +.. _backup-lin: + +===== +Linux +===== + +There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop or desktop, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy. + +Remote Backups +-------------- + +Ubuntu +====== + +#. Open the file manager +#. Right-click the folder that you want to share and click ``Local Network Share`` from the menu. +#. In the resulting window, select the check box for ``Share this folder`` and then check the boxes for Allow others to create and delete files in this folder and Guest access. +#. (Optional) Create a description in the ``Comment`` section +#. Click ``Create Share`` +#. Click ``Add the permissions automatically`` +#. Next, in your Embassy interface, go to ``Embassy`` -> ``Create Backup`` + +Other Linux +=========== + +#. Install Samba + # sudo yum install samba For CentOS/Redhat + # sudo dnf install samba For Fedora + # sudo apt install samba For Debian + # sudo pacman -S samba For Arch + +Local Backups +------------- + +#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered. +#. Plug in power to your hub or drive +#. Boot Embassy and go to ``Embassy`` -> ``Create Backup`` +#. diff --git a/site/source/support/user-manual/walkthrough/backup/backup-mac.rst b/site/source/support/user-manual/walkthrough/backup/backup-mac.rst new file mode 100644 index 0000000..b5b725b --- /dev/null +++ b/site/source/support/user-manual/walkthrough/backup/backup-mac.rst @@ -0,0 +1,30 @@ +.. _backup-mac: + +=== +Mac +=== + +There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop or desktop, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy. + +Remote Backups +-------------- + +#. go to system settings +#. click sharing +#. click file sharing +#. click the + under shared folders +#. add a folder +#. click options +#. enable Windows file sharing for the user you would like to use to authenticate +#. click done +#. enter the name of your macbook, as shown in the computer name field at the top of the sharing page into the hostname field in embassy ui +#. enter the name of the folder as shown in the shared folders section as the path +#. enter your macbook username and password for the user that you enabled windows file sharing for + +Local Backups +------------- + +#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered. +#. Plug in power to your hub or drive +#. Boot Embassy and go to ``Embassy`` -> ``Create Backup`` +#. diff --git a/site/source/support/user-manual/walkthrough/backup/backup-win.rst b/site/source/support/user-manual/walkthrough/backup/backup-win.rst new file mode 100644 index 0000000..c63cf55 --- /dev/null +++ b/site/source/support/user-manual/walkthrough/backup/backup-win.rst @@ -0,0 +1,30 @@ +.. _backups-win: + +======= +Windows +======= + +There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop or desktop, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy. + +Remote Backups +-------------- + +#. Create a folder +#. Right click the folder +#. select "properties" +#. click the share tab +#. click share... +#. select a user you want to use for login, or select everyone +#. click share +#. enter your computer name into the hostname field in embassy ui (the name is shown after a \\ in the windows ui) +#. enter the path that is shown after the hostname in the windows ui into the path field +#. enter your username for the windows computer +#. enter the password for the windows computer + +Local Backups +------------- + +#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered. +#. Plug in power to your hub or drive +#. Boot Embassy and go to ``Embassy`` -> ``Create Backup`` +#. diff --git a/site/source/support/user-manual/walkthrough/backup/index.rst b/site/source/support/user-manual/walkthrough/backup/index.rst new file mode 100644 index 0000000..32a1a7f --- /dev/null +++ b/site/source/support/user-manual/walkthrough/backup/index.rst @@ -0,0 +1,14 @@ +.. _backup: + +======= +Backups +======= + +In addition to safekeeping of a good master password, maintaining good backups are among the few major responsibilities required to keep the benefits and freedom that come with self-hosting. + +.. toctree:: + :maxdepth: 2 + + backup-lin + backup-mac + backup-win diff --git a/site/source/support/user-manual/walkthrough/index.rst b/site/source/support/user-manual/walkthrough/index.rst index 41ffcc7..fcfccf2 100644 --- a/site/source/support/user-manual/walkthrough/index.rst +++ b/site/source/support/user-manual/walkthrough/index.rst @@ -11,5 +11,5 @@ An overview of EmbassyOS general capabilities. overview updates - backup + backup/index password