Merge branch 'develop' of https://github.com/Superalgos/Superalgos into develop

2021-03-15 11:50:36 +01:00
commit 3c773d5f1e
@@ -56,7 +56,7 @@
    onresize="onResize()">
    <div id="contributors" class="credits">
        <p id="credits-page-status-paragraph" class="credits-yellow">The UI is loading...</p>
-        <p>Superalgos is <span class="credits-red">forever free</span> and <span class="credits-red">open-source</span>, and it's 
+        <p>Superalgos is <span class="credits-red">open source and free, for everyone, forever</span>, and it's 
            <span class="credits-red">relentlessly improving</span> thanks to the involvement of contributors:</p>
        <p>Luis Fernando Molina, Julian Molina, Andreja Cobeljic, Matías Benitez, Ira Miller, Eduardo Remis,
            Jeff Braun, rico4dev, 9808us, Barry Low, Nikola Bjelogrlic, Hirajin Koizuko, Francisco J. Santillán, Norman, 
@@ -203,4 +203,4 @@

 </body>

-</html>
+</html>
@@ -14,8 +14,8 @@
        },
        {
            "style": "Json",
-            "text": "docs.update",
-            "updated": 1610710006400
+            "text": "app.update",
+            "updated": 1615612258411
        },
        {
            "style": "Title",
@@ -3,8 +3,8 @@
    "pageNumber": 21,
    "type": "Docs Anchor Style",
    "definition": {
-        "text": "Amchor paragraphs are used together with the Docs Goto Command. When you want to generate a Docs Link to an specific part of a Docs Page, you first need to create an Anchor paragraph in order to be able to create the link to that part of the page.",
-        "updated": 1609258745310
+        "text": "Anchor paragraphs are used together with the Docs Goto Command. When you want to generate a Docs Link to an specific part of a Docs Page, you first need to create an Anchor paragraph in order to be able to create the link to that part of the page.",
+        "updated": 1615591597546
    },
    "paragraphs": [
        {
@@ -11,10 +11,14 @@
        "updated": 1610815737032
    },
    "paragraphs": [
+        {
+            "style": "Note",
+            "text": "Github API is currently at the \"Getting Started\" workspace, under APIs.",
+            "updated": 1615593559409
+        },
        {
            "style": "Callout",
-            "text": "Copy the token, open the Github API node config, and paste it between the double quotes of the token parameter. Fill in the username parameter with your GitHub.com user, not your email!",
-            "updated": 1610984794891
+            "text": "Copy the token, open the Github API node config, and paste it between the double quotes of the token parameter. Fill in the username parameter with your GitHub.com user, not your email!"
        },
        {
            "style": "Note",
@@ -71,22 +71,16 @@ Before you begin, it is recommended that you set up Chrome/Safari as your defaul

 # Superalgos Client Installation

-**1.** Scroll the page all the way to the top. Find and click the **Fork** button to create your fork/copy of this repository. To fork Superalgos you need a GitHub account. If you don't have one, go ahead and create it.
+**1.** Scroll the page all the way to the top. Find and click the **Fork** button to create your fork/copy of this repository. To fork Superalgos you need a Github account. If you don't have one, go ahead and create it.

 **NOTE:** A Fork is required for your contributions to the project. The reason why Superalgos is free and open-source is that the project has set up a <a href="https://superalgos.org/community-business.shtml" target="_blank">Collective Business</a> in which all users may participate. The way to participate is to <a href="https://superalgos.org/community-contribute.shtml" target="_blank">contribute</a> to make Superalgos better. The project's <a href="https://superalgos.org/token-overview.shtml" target="_blank">token</a> is distributed among contributors.

 **2.** Once the fork is created, you will land on the page of your fork. Copy the URL from your browser's address bar.

-**3.** In your computer/laptop/server, open a command prompt or terminal as an administrator (to avoid issues with permissions) and type:
+**3.** In your computer/laptop/server, open a command prompt or terminal. Make sure you are in a directory where you have write permissions (on most systems the terminal will open in your user’s home directory, so you’re good). Clone the git repository using the command

 ```
-git clone
-```
-
-**5.** Don't hit Enter yet! Complete the command by pasting the URL of your fork!
-
-```
-git clone + URL of your Superalgos fork.
+git clone <URL of your Superalgos fork>
 ```

 For example, if your Github username is John, the command will look like this:
@@ -95,7 +89,7 @@ For example, if your Github username is John, the command will look like this:
 git clone https://github.com/John/Superalgos
 ```

-Ok, you have installed Superalgos. To run the App, jump to the section Usage below.
+This creates the `Superalgos` folder in the current directory, which contains the whole installation. To run the App, jump to the section Usage below.

 ## Installation Notes

@@ -103,9 +97,7 @@ Ok, you have installed Superalgos. To run the App, jump to the section Usage bel

 **2.** The software includes an in-app self-update command / feature. It will help you stay up-to-date with the latest version of the software. Updates are on-demand, so don't worry about undesired updates. The project moves very fast and new features become available regularly, particularly if you choose to run the software in the ```develop``` branch (you may switch branches from within the app).

-**3.** You are better off running the git clone command as an administrator to avoid permission issues while creating the Superalgos folder and downloading the repository. It may work without admin powers depending on your setup, particularly if you are running the command on a folder where you've got write permissions.
-
-**4.** Before installing the client on a remote computer in an attempt to access the UI from a different machine, we highly recommend you do a standard installation on your PC / laptop first. Leave your Raspberry Pi or server for later, once you have done all available tutorials. This single tip will save you a lot of time: you don't need to add complexity before you learn how to handle the app.
+**3.** Before installing the client on a remote computer in an attempt to access the UI from a different machine, we highly recommend you do a standard installation on your PC / laptop first. Leave your Raspberry Pi or server for later, once you have done all available tutorials. This single tip will save you a lot of time: you don't need to add complexity before you learn how to handle the app.

 ## Migrating from Superalgos Beta 8

@@ -162,6 +154,47 @@ node run minMemo noBrowser
 **1.** We are testing the UI on Google Chrome and Safari on macOS only. It may work on other browsers as well &mdash; or not. If you are running on a different browser and ever need support, make sure you mention that fact upfront, or even better, try on Chrome/Safari first.

 **TIP:** If your computer has 8 GB of RAM or less, use ```node run minMemo``` to run the system with minimal RAM requirements.
+ 
+# Running Superalgos on a headless linux server as a daemon
+
+If you’re running Superalgos on a headless linux server like a Raspberry Pi, you might want to run it as a daemon so it isn’t attached to your current login session. The easiest, most standard way to go about this is probably using `systemd`. Most linux distributions use it as default init system/service manager.
+
+## Using `systemd`
+
+Create a `superalgos.service` file looking like this (change `<user>` to your user name and `/path/to/Superalgos` to your Superalgos folder, for instance `/home/John/Superalgos`):
+```
+[Unit]
+Description=Superalgos client
+
+[Service]
+Type=simple
+User=<user>
+WorkingDirectory=/path/to/Superalgos
+ExecStart=/usr/bin/node run minMemo noBrowser
+
+[Install]
+WantedBy=multi-user.target
+
+```
+There is no need to run Superalgos as root so we’re running it as a user. The `minMemo` option assumes you’re running on a small machine like a Raspberry Pi, while `noBrowser` makes sense for running daemonized.
+
+Now, as root (or using `sudo`), put the file `superalgos.service` you just created in `/etc/systemd/system/` and issue the command
+```
+systemctl enable superalgos
+```
+This will install the service so that Superalgos is started on boot. To start it manually, do (again as root or with `sudo`)
+```
+systemctl start superalgos
+```
+
+To see the output of Superalgos, use
+```
+journalctl -u superalgos
+```
+or to follow the output,
+```
+journalctl -u superalgos -f
+```

 # Uninstall