mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-31 04:23:41 +00:00
rename all svgs to pngs for proper display
This commit is contained in:
Lucy Cifferello
@@ -15,5 +15,5 @@ Un-installing
|
||||
|
||||
To remove a service, navigate to the :ref:`Services tab<services-tab>` *> [Service Name] > Actions > Uninstall*.
|
||||
|
||||
.. figure:: /_static/images/services/acts.svg
|
||||
.. figure:: /_static/images/services/acts.png
|
||||
:width: 60%
|
||||
|
||||
@@ -8,20 +8,20 @@ After installation or update, some services require configuration before they ca
|
||||
|
||||
Navigate to the `Services tab <services-tab>` *> [Service Name] > Config*
|
||||
|
||||
.. figure:: /_static/images/services/service-needs-config.svg
|
||||
.. figure:: /_static/images/services/service-needs-config.png
|
||||
:width: 60%
|
||||
|
||||
Traditionally, configuring services was a massive headache and a huge barrier to running a personal server. But no more! The Embassy's revolutionary service config system makes the process transparent, simple, and safe.
|
||||
|
||||
.. figure:: /_static/images/services/service4.svg
|
||||
.. figure:: /_static/images/services/service4.png
|
||||
:width: 60%
|
||||
|
||||
Config options are defined by the service developer and can be almost anything. They are represented as simple UI elements - such as toggles and drop downs - and they include explanations and validations, such that users understand their purpose and are prevented from making mistakes.
|
||||
|
||||
.. figure:: /_static/images/services/service5.svg
|
||||
.. figure:: /_static/images/services/service5.png
|
||||
:width: 60%
|
||||
|
||||
You can change your configuration at any time from a Service's main page:
|
||||
|
||||
.. figure:: /_static/images/services/config.svg
|
||||
.. figure:: /_static/images/services/config.png
|
||||
:width: 60%
|
||||
|
||||
@@ -6,7 +6,7 @@ Donate
|
||||
|
||||
Currently, this is a link provided by the service package developer so that you may donate to them or the developer of the service they packaged directly. If this is not provided, a pop-up message will let you know this, and you will need to find the devs on their own platforms in order to donate.
|
||||
|
||||
.. figure:: /_static/images/services/donate.svg
|
||||
.. figure:: /_static/images/services/donate.png
|
||||
:width: 60%
|
||||
|
||||
.. topic-box::
|
||||
|
||||
@@ -8,25 +8,25 @@ Installing
|
||||
|
||||
To add a new service, simply find it's listing inside the :ref:`Service Marketplace <service-marketplace>` tab: *[Service Name] >* ``Install``. Let's install Synapse as an example:
|
||||
|
||||
.. figure:: /_static/images/services/service0.svg
|
||||
.. figure:: /_static/images/services/service0.png
|
||||
:width: 60%
|
||||
|
||||
.. figure:: /_static/images/services/service1.svg
|
||||
.. figure:: /_static/images/services/service1.png
|
||||
:width: 60%
|
||||
|
||||
Depending on the size of the service and your Internet connection, installation should take between 60 seconds and a few minutes.
|
||||
|
||||
.. figure:: /_static/images/services/service2.svg
|
||||
.. figure:: /_static/images/services/service2.png
|
||||
:width: 60%
|
||||
|
||||
You may click *View Service* at any time to view install progress, or after install to go to the Service page. Many services will need to be configured after install. You can use the default options, or change to your liking. See :ref:`configuration<service-config>` for details.
|
||||
|
||||
.. figure:: /_static/images/services/service3.svg
|
||||
.. figure:: /_static/images/services/service3.png
|
||||
:width: 60%
|
||||
|
||||
You will see a screen like the following when install is complete. Then you're ready to :ref:`configure <service-config>` your service!
|
||||
|
||||
.. figure:: /_static/images/services/service4.svg
|
||||
.. figure:: /_static/images/services/service4.png
|
||||
:width: 60%
|
||||
|
||||
.. note:: You can only use a service once its :ref:`dependencies <service-dependencies>` are met, its :ref:`configuration<service-config>` is complete, it has been started, and is in a *running* :ref:`status <service-status>`.
|
||||
|
||||
@@ -6,12 +6,12 @@ Instructions
|
||||
|
||||
To view the instructions for a particular service, navigate to the :ref:`Services tab <services-tab>` *> [Service Name] > Instructions*.
|
||||
|
||||
.. figure:: /_static/images/services/instruct.svg
|
||||
.. figure:: /_static/images/services/instruct.png
|
||||
:width: 60%
|
||||
|
||||
Instructions will provide you with service-specific direction, provided by the service package developer, on what to expect, and how to use your new service.
|
||||
|
||||
.. figure:: /_static/images/services/service-instruct.svg
|
||||
.. figure:: /_static/images/services/service-instruct.png
|
||||
:width: 60%
|
||||
|
||||
.. note:: For advanced instructions and integration guides, visit the wrapper repository for an `available service <https://marketplace.start9.com>`_.
|
||||
|
||||
@@ -6,10 +6,10 @@ Interfaces
|
||||
|
||||
Interfaces are URLs that a :ref:`Service<services>` uses to communicate in various ways with other software. Many Services will only have one interface, perhaps with a Tor and LAN address, to denote where it is hosted / accessed. Other services, such as Bitcoin or Lightning Nodes, may have several interfaces for different use-cases.
|
||||
|
||||
.. figure:: /_static/images/services/service-ints.svg
|
||||
.. figure:: /_static/images/services/service-ints.png
|
||||
:width: 60%
|
||||
|
||||
To view the instructions for a particular service, navigate to the :ref:`Services tab <services-tab>` *> [Service Name] > Properties*. From there you can copy a URL to your clipboard for use with external software.
|
||||
|
||||
.. figure:: /_static/images/services/service-ints0.svg
|
||||
.. figure:: /_static/images/services/service-ints0.png
|
||||
:width: 60%
|
||||
|
||||
@@ -8,5 +8,5 @@ Naviage to *Services > [Service Name] > Logs*
|
||||
|
||||
Every service emits logs while it is in a *running* state. Logs give an *under-the-hood* glimpse of a service and can be extremely useful for debugging purposes. To a non-technical user, logs may look like gibberish, and sometimes there is nothing to see at all. You can check here if you have an issue with a service, and if you are talking to support, they may ask you to screenshot or copy these logs to help discover the root of the problem.
|
||||
|
||||
.. figure:: /_static/images/services/logs.svg
|
||||
.. figure:: /_static/images/services/logs.png
|
||||
:width: 60%
|
||||
|
||||
@@ -11,7 +11,7 @@ Services are very similar to Applications on a mobile device. The biggest diffe
|
||||
The Service Page
|
||||
----------------
|
||||
|
||||
.. figure:: /_static/images/services/service8.svg
|
||||
.. figure:: /_static/images/services/service8.png
|
||||
:width: 60%
|
||||
|
||||
The Service Page
|
||||
@@ -20,7 +20,7 @@ In the image above, we see an example of a Service's homescreen, where you can a
|
||||
|
||||
Below, we highlight the quick, need-to-know information of a Service that a user will want to see right away.
|
||||
|
||||
.. figure:: /_static/images/services/service00.svg
|
||||
.. figure:: /_static/images/services/service00.png
|
||||
:width: 60%
|
||||
|
||||
.. _service-status:
|
||||
|
||||
@@ -6,7 +6,7 @@ Properties
|
||||
|
||||
Properties can contain both static and dynamic information about a service. They could be almost anything: a default username/password, an invite code, or a list of peers - anything the service developer thought might be useful.
|
||||
|
||||
.. figure:: /_static/images/services/props.svg
|
||||
.. figure:: /_static/images/services/props.png
|
||||
:width: 60%
|
||||
|
||||
To view the instructions for a particular service, navigate to the :ref:`Services tab <services-tab>` *> [Service Name] > Properties*.
|
||||
|
||||
Reference in New Issue
Block a user