Move server docs to main repo (#178)

Moved server docs to main repository

Author: andrasbacsai

README.md

@@ -66,6 +66,8 @@ You can find a list of all commands and options in the [docs](./docs/README.md).
 ## Docs
 
 - [Basics](docs/Basics.md)
+- [Server Installation](docs/ServerInstallation.md)
+- [Server Configuration](docs/ServerConfiguration.md)
 - [Advanced topics](docs/Advanced.md)
 - [FAQ](docs/FAQ.md)
 - [Contribution Guideline](docs/Contributing.md)

docs/README.md

@@ -1,9 +1,13 @@
 ## Table of Contents
 
 - [Basics](Basics.md)
+- [Server Installation](ServerInstallation.md)
+- [Server Configuration](ServerConfiguration.md)
 - [Advanced topics](Advanced.md)
 - [FAQ](FAQ.md)
+- [Contribution Guideline](Contributing.md)
 - [Templates guide](TemplatesGuide.md)
+- [Recipes guide](RecipesGuide.md)
 - [Using nightly versions](Nightly.md)
-- [Articles, video and related links](Links.md)
+- [Tutorials, articles, video and related links](Links.md)
 - [Change Log](../CHANGELOG.md)

docs/ServerConfiguration.md

@@ -0,0 +1,50 @@
+
+## Server Configuration
+
+Exoframe stores its config in `~/.exoframe/server.config.yml`.  
+Currently it contains the following settings:
+
+```yaml
+# whether debug mode is enabled, default "false"
+debug: false
+
+# whether to enable letsencrypt, default "false"
+letsencrypt: false
+
+# email used for letsencrypt
+letsencryptEmail: [email protected]
+
+# whether to apply gzip compression, default "true"
+compress: true
+
+# base top-level domain to use for deployments without domains specified, default "false"
+# used as postfix, e.g. if you specify ".example.com" (dot is auto-prepended if not present)
+# all your deployments will be autodeployed as "deployment-id.example.com"
+baseDomain: false
+
+# CORS support; can be "true" ("*" header) or object with "origin" property, default "false"
+cors: false
+
+# Traefik image to be used; set to "false" to disable traefik management, default "traefik:latest"
+traefikImage: 'traefik:latest'
+
+# Traefik container name, default "exoframe-traefik"
+traefikName: 'exoframe-traefik'
+
+# Additional Traefik start args, default []
+traefikArgs: []
+
+# Network used by traefik to connect services to, default "exoframe"
+exoframeNetwork: 'exoframe'
+
+# server image update channel; can be "stable" or "nightly", default "stable"
+updateChannel: 'stable'
+
+# path to folder with authorized_keys, default "~/.ssh"
+publicKeysPath: '/path/to/your/public/keys'
+
+# whether Exoframe server whould be running in swarm mode, default "false"
+swarm: false
+```
+
+_Warning:_ Most changes to config are applied immediately. With exception of Letsencrypt config. If you are enabling letsencrypt after Traefik instance has been started, you'll need to remove Traefik and then restart Exoframe server for changes to take effect.

docs/ServerInstallation.md

@@ -0,0 +1,69 @@
+# Exoframe Server
+
+## Installation and Usage
+
+1.  Make sure you have Docker [installed and running](https://docs.docker.com/engine/installation/) on your host.
+2.  Pull and run Exoframe server using docker:
+
+```sh
+docker run -d \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  -v /path/to/exoframe-folder:/root/.exoframe \
+  -v /home/user/.ssh/authorized_keys:/root/.ssh/authorized_keys:ro \
+  -e EXO_PRIVATE_KEY=your_private_key \
+  --label traefik.backend=exoframe-server \
+  --label traefik.frontend.rule=Host:exoframe.your-host.com \
+  --restart always \
+  --name exoframe-server \
+  exoframe/server
+
+# Explanation for arguments:
+# this allows Exoframe to access your docker
+-v /var/run/docker.sock:/var/run/docker.sock
+
+# /path/to/exoframe-folder should be path on your server
+# to desired folder that'll hold Exoframe configs
+-v /path/to/exoframe-folder:/root/.exoframe
+
+# /home/user/.ssh/authorized_keys should point to your authorized_keys file
+# for SSH that holds allowed public keys
+-v /home/user/.ssh/authorized_keys:/root/.ssh/authorized_keys:ro
+
+# this is your private key used for JWT encryption
+-e EXO_PRIVATE_KEY=your_jwt_encryption_key
+
+# this is used to tell traefik to which deployment current docker service belongs
+--label traefik.backend=exoframe-server
+
+# this is used to tell traefik on which domain should Exoframe server be listening
+--label traefik.frontend.rule=Host:exoframe.your-host.com
+```
+
+3.  Edit config file to fit your needs (see section below)
+
+Then install [Exoframe CLI](https://github.com/exoframejs/exoframe), point it to your new Exoframe server and use it.
+
+## Installation and usage in Swarm mode
+
+Exoframe also supports running in [Swarm mode](https://docs.docker.com/engine/swarm/).  
+To run Exoframe server in swarm, you need to do the following:
+
+1.  Make sure you have Docker on your host.
+2.  Make sure your Docker has [Swarm mode enabled](https://docs.docker.com/engine/swarm/swarm-tutorial/create-swarm/).
+3.  Pull and run Exoframe server using Docker on your manager node:
+
+```
+docker service create \
+  --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock \
+  --mount type=bind,source=/path/to/exoframe-folder,target=/root/.exoframe \
+  --mount type=bind,source=/home/user/.ssh/authorized_keys,target=/root/.ssh/authorized_keys,readonly \
+  -e EXO_PRIVATE_KEY=your_private_key \
+  --label traefik.backend=exoframe-server \
+  --label traefik.frontend.rule=Host:exoframe.your-host.com \
+  --label traefik.port=8080 \
+  --constraint=node.role==manager \
+  --name exoframe-server \
+  exoframe/server
+```
+
+Note that both Exoframe server and Traefik will be run on your manager node.