revap dev docs

site/source/service-packaging/advanced/dev-tools/embassy-cli.rst

@@ -0,0 +1,52 @@
+.. _embassy-cli:
+
+===========
+Embassy-CLI
+===========
+
+.. warning:: This is for advanced users only!! Anything you do while SSH'd into your Embassy is NOT SUPPORTED, unless under the guidance of a Start9 technician.
+
+When interacting with Embassy directly, you will invariably want to use ``embassy-cli``.  Embassy-CLI can control EmbassyOS in many of the same ways that the UI can, but with finer controls and deeper insights.
+
+In order to use Embassy-CLI, you will first need to authorize yourself with the following command...
+
+    .. code-block:: bash
+
+        embassy-cli auth login
+
+    and enter your Embassy Master Password at the prompt.
+
+
+You can enter ``embassy-cli help`` or ``embassy-cli <option> help`` to get an overview of capabilities:
+
+    .. code-block:: bash
+
+        Embassy CLI
+
+        USAGE:
+            embassy-cli [OPTIONS] <SUBCOMMAND>
+
+        FLAGS:
+                --help       Prints help information
+            -V, --version    Prints version information
+
+        OPTIONS:
+            -c, --config <config>
+            -h, --host <host>
+            -p, --proxy <proxy>
+
+        SUBCOMMANDS:
+            auth            Login/logout and manage sessions
+            backup          Manage backups
+            db              Interact with the Database
+            disk            Information on the external drive
+            echo            Echoes
+            git-info        Print the current git hash
+            help            Prints this message or the help of the given subcommand(s)
+            inspect         Details on services and their components
+            net             Network information
+            notification    Control UI notifications
+            package         Interact with packages
+            server          EmbassyOS operations and information
+            ssh             Manage SSH keys
+            wifi            Manage WiFi networks

site/source/service-packaging/advanced/dev-tools/embassy-sdk.rst

@@ -0,0 +1,42 @@
+.. _embassy-sdk:
+
+===========
+Embassy-SDK
+===========
+
+.. warning:: This is for developers only!! Anything you do while SSH'd into your Embassy is NOT SUPPORTED, unless under the guidance of a Start9 technician.
+
+You can install to your system by running the following from you ``embassy-os`` directory:
+
+    .. code-block:: bash
+
+        cargo install --bin=embassy-sdk --path=. --no-default-features --verbose
+
+
+You can enter ``embassy-sdk help`` or ``embassy-sdk <option> help`` to get an overview of capabilities:
+
+    .. code-block:: bash
+
+        embassy-sdk --help
+        Embassy SDK
+
+        USAGE:
+            embassy-sdk [OPTIONS] <SUBCOMMAND>
+
+        FLAGS:
+            -h, --help       Prints help information
+            -V, --version    Prints version information
+
+        OPTIONS:
+            -c, --config <config>
+
+        SUBCOMMANDS:
+            git-info    Print current git hash
+            help        Prints this message or the help of the given subcommand(s)
+            init        Initialize
+            inspect     Inspect a .s9pk
+            pack        Package a service into the .s9pk format
+            verify      Verify a .s9pk is valid
+
+
+Please visit https://github.com/Start9Labs/embassy-os/tree/master/backend for more details

site/source/service-packaging/advanced/dev-tools/embassyd.rst

@@ -0,0 +1,22 @@
+.. _embassyd:
+
+========
+EmbassyD
+========
+
+.. warning:: This is for advanced users only!! Anything you do while SSH'd into your Embassy is NOT SUPPORTED, unless under the guidance of a Start9 technician.
+
+EmbassyD is the daemon that runs everything that could be considered EmbassyOS.
+
+When SSH'd into your Embassy, you may see the status of EmbassyD with the following:
+
+    .. code-block:: bash
+
+        systemctl status embassyd
+
+If you need to restart the daemon for some reason, you can do so with:
+
+    .. code-block:: bash
+
+        systemctl restart embassyd
+        

site/source/service-packaging/advanced/dev-tools/index.rst

@@ -0,0 +1,15 @@
+.. _dev-tools:
+
+===============
+Developer Tools
+===============
+
+Brief overviews of Developer Tools that will come in handy when :ref:`packaging a service<service-packaging>`, or interacting directly with the OS to learn or contribute to the project.
+
+.. toctree::
+  :maxdepth: 2
+
+  embassyd
+  embassy-cli
+  embassy-sdk
+  service-container

site/source/service-packaging/advanced/dev-tools/service-container.rst

@@ -0,0 +1,19 @@
+.. _exec-service-container:
+
+==================
+Service Containers
+==================
+
+For simplicity, EmbassyOS is designed to be completely operated via the :ref:`WebUI<web-ui>`, however, your device belongs to you and if you want to "lift the hood" and access the internals of the software, you may do so.  This guide will show you how to enter a Service's :ref:`container<containers>` in order to directly interface with it and issue commands.
+
+.. warning:: The following guide is for those that have advanced command line skills, or those who are being guided by a Start9 support technician.  Nothing you do inside a container is supported unless under the direction of Start9.  Here be dragons!!
+
+This guide assumes you already have :ref:`SSH Access<ssh-setup>` setup on your machine.
+
+Open a terminal, ssh into your device, and enter the following command, replacing ``<package-id>`` with the name of the service you are trying to access.  You can list the services with ``embassy-cli package list`` (you will need to be logged in under ``embassy-cli`` for this).  You will need to either be ``root`` or use ``sudo``.
+
+    .. code-block:: bash
+
+        docker exec -it <package-id>.embassy sh
+
+This will give you a shell within the container.  Reminder that nothing you do in here is supported, please be careful!