Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 10:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

re-arrange the user docs (#76)

Browse Source 
* re-arrange the user docs

* Minor description edit

* update styles

* fix service links

Co-authored-by: kn0wmad <kn0wmad@protonmail.com>
Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
This commit is contained in:
Matt Hill
2022-02-18 08:49:53 -07:00
committed by GitHub
parent c38d5c1a0c
commit aed86e7e6c
151 changed files with 500 additions and 781 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
site/source/developer-docs/specification/instructions.rst Normal file
View File

@@ -0,0 +1,61 @@
.. _service_instructions:
============
Instructions
============
Within each wrapper repository, a file should exist that includes instructions for a service. This file should include any pertinent documentation, instructions, external integrations, or other details about the service that users or developers might find relevant.
This markdown formatted file will be rendered in the "Instructions" section within the service page on EmbassyOS:
.. figure:: /_static/images/services/service-instruct.png
:width: 80%
:alt: Embassy Pages Instructions
Below is the markdown file for Embassy Pages' instructions, as shown above:
.. code-block::
# Embassy Pages
## About
Embassy Pages is a simple web server that uses directories inside File Browser to serve Tor websites. Your website could be a blog, a resume, a portfolio, a business landing page, a product brochure, or just a set of static folders and/or files that you want to share with the world.
When you first install Embassy Pages, there will be a default Homepage hosted at the root, <tor-address>.onion. You can change the behavior of this page, and you can also create Subdomain websites. For example, one site could be hello.<tor-address>.onion and another could be goodbye.<tor-address>.onion. What is served from the Homepage and each Subdomain is totally up to you.
Self-hosting Tor websites using Embassy Pages is easy, permissionless, and censorship-resistant; there are no trusted third parties involved.
Anyone can do it. No one can stop it.
## Instructions
1. Inside `Config`, you can easily change the behavior of your Homepage to serve:
a. A list of hyperlinks to all your Subdomains
b. A personal web page
c. An automatic redirect to a Subdomain
d. A static web page that tells anyone visiting it to fuck off, politely.
2. Inside `Config`, you can create one or more Subdomains, giving each a unique name.
3. To serve a personal website, simply upload the website directory to File Browser. Then, inside the settings for a particular page (either your Homepage or a Subdomain), enter the path to that directory. For example, a path of websites/blog would tell Embassy Pages that it can find the blog website inside the websites directory in File Browser.
4. A list of all your Subdomains can be found inside the Properties section of your Embassy Pages service.
## Restore from Backup
1. In `Config`, select "Restore from Backup".
2. After the restoration completes, navigate to the Marketplace.
3. Downgrade Embassy Pages.
4. Upgrade Embassy Pages to the latest version.
5. Start Embassy Pages.
6. Embassy Pages is now successfully restored!
Example
-------
The `bitcoind wrapper <https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs>`_ demonstrates a good use of instructions and external integrations.
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`