From 80687f82536262a62870b5892828ae3328e89de0 Mon Sep 17 00:00:00 2001
From: Benoit Lavenier <benoit.lavenier@e-is.pro>
Date: Fri, 20 Mar 2020 16:13:04 +0100
Subject: [PATCH] [fix] Fix documentation for web site deployment. [fix] Remove
web site installation in README.md [fix] Add web extension installation in
README.md
---
README.md | 97 +++++++++--------------------------------------
doc/deploy_web.md | 93 ++++++++++++++++++++++++++++++++++++---------
2 files changed, 92 insertions(+), 98 deletions(-)
diff --git a/README.md b/README.md
index 0ec18c970..6557a43f8 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,25 @@
# Cesium
- - [Unhosted webapp](https://unhosted.org) client for any [Duniter](https://duniter.org) crypto-currency.
- - Manage your wallet, certify your friends, and more !
- - [Web site](https://cesium.app)
+Cesium is wallet client software for [Duniter](https://duniter.org) crypto-currency, like Äž1.
+Cesium allow you to manage your wallet, certify your friends, and more!
+
+Cesium is an [Unhosted](https://unhosted.org) Progressive Web Application (PWA), using AngularJS and Ionic.
+
+Please visit th Cesium web site: [cesium.app](https://cesium.app)
## Install
+### As a web extension (Firefox, Chrome)
+
+ - Download the [latest extension release](https://github.com/duniter/cesium/releases/latest)
+
+ - Drag/drop the file into your browser;
+
+ - Confirm the installation.
+
+ That's it! A new button is appeared, on the top right corner.
+
### On desktop computer
- Download the [latest release](https://github.com/duniter/cesium/releases/latest)
@@ -29,83 +42,7 @@
- iOS
* Coming soon...;
-### As a web site
-
-#### First installation
-
-Cesium can be easily installed on most web server :
-
- - Download the [latest release](https://github.com/duniter/cesium/releases/latest) (file `cesium-vx.y.z-web.zip`);
- - Unpack into an empty directory;
- - Configure the web server engine (e.g. apache, nginx):
- * Add a new virtual host, that use the directory as `web root`.
- * Make sure the file `index.html` exist inside this directory.
-
-#### Update to last version
-
-On Linux distributions, an update script can be used to update your Cesium web site:
-
-```
-cd <CESIUM_WEB_ROOT>
-curl -kL https://git.duniter.org/clients/cesium-grp/cesium/raw/master/install.sh | bash
-```
-or:
-
-```
-cd <CESIUM_WEB_ROOT>
-wget -qO- https://git.duniter.org/clients/cesium-grp/cesium/raw/master/install.sh | bash
-```
-
-
-**Note**: You may need root permission to write files. If so just replace `| bash` with `| sudo bash`.
-
-#### Changing default settings
-
-To change default configuration, on a Cesium web site:
-
- - Edit the file `config.js` in the web root directory, and change some properties:
-
-```js
-angular.module("cesium.config", [])
-.constant("csConfig", {
- "fallbackLanguage": "en",
- "rememberMe": false,
- "timeWarningExpireMembership": 5184000,
- "timeWarningExpire": 7776000,
- "useLocalStorage": true,
- "useRelative": true,
- "decimalCount": 4,
- "helptip": {
- "enable": true,
- "installDocUrl": "https://github.com/duniter/duniter/blob/master/doc/install-a-node.md"
- },
- "node": {
- "host": "g1.duniter.org",
- "port": "443"
- },
- "plugins": {
- "es": {
- "enable": "true",
- "host": "g1.data.duniter.fr",
- "port": "443"
- }
- },
- "version": "1.3.7",
- "build": "2019-04-02T08:27:57.915Z"
-});
-```
-
- - Configure a Duniter node:
-
- * set `node.host` and `node.port` to the default node address.
-
- - Configure the optional extension for [Cesium+](https://git.duniter.org/clients/cesium-grp/cesium-plus-pod/)
-
- * set `plugins.es.host` and `plugins.es.port` to the default Cesium+ Pod (aka ES) address.
-
- * set `plugins.es.enable` with [true|false] to change the default extension state.
-
-To learn more about configuration options, see the [detailed documentation](doc/configuration.md).
+
#### Yunohost package
diff --git a/doc/deploy_web.md b/doc/deploy_web.md
index 4498b0201..3f4baa232 100644
--- a/doc/deploy_web.md
+++ b/doc/deploy_web.md
@@ -10,33 +10,90 @@
## First deployment
-1. Create the root directory:
- ```bash
- cd /var/www/
- sudo mkdir cesium
- cd cesium
- ```
-
-2. Download and unzip:
- ```bash
- cd /var/www/cesium
- wget -kL https://.../cesiumvx.y.z.zip
- unzip -o /var/www/cesium cesiumvx.y.z.zip
- ```
-
-3. Configure Cesium default settings, by editing the file `config.js`;
+1. Download the [latest release](https://github.com/duniter/cesium/releases/latest) (file `cesium-vx.y.z-web.zip`);
+
+2. Unpack into an empty directory;
-4. Configure your web engine (e.g. Apache, nginx) to use the root directory, by creating a new `location` or a new `virtualhost`;
+3. Change Cesium default settings, by editing the file `config.js` (see next bottom);
+4. Configure the web server engine (e.g. Apache, nginx):
+ * Add a new `location` (or a new `virtual host`), that use the directory as `web root`.
+ * Make sure the file `index.html` exist inside this directory.
+
Please refer to your engine documentation.
5. Restart your web engine.
That's it !
-##Â Update to the latest version
-## Example Bash script
+## Configure Cesium default settings
+
+To change default configuration, that Cesium will use:
+
+- Edit the file `config.js` in the web root directory, and change some properties:
+
+```js
+angular.module("cesium.config", [])
+.constant("csConfig", {
+ "fallbackLanguage": "en",
+ "rememberMe": false,
+ "timeWarningExpireMembership": 5184000,
+ "timeWarningExpire": 7776000,
+ "useLocalStorage": true,
+ "useRelative": true,
+ "decimalCount": 4,
+ "helptip": {
+ "enable": true,
+ "installDocUrl": "https://github.com/duniter/duniter/blob/master/doc/install-a-node.md"
+ },
+ "node": {
+ "host": "g1.duniter.org",
+ "port": "443"
+ },
+ "plugins": {
+ "es": {
+ "enable": "true",
+ "host": "g1.data.duniter.fr",
+ "port": "443"
+ }
+ },
+ "version": "1.3.7",
+ "build": "2019-04-02T08:27:57.915Z"
+});
+```
+
+- Configure a Duniter node:
+ * set `node.host` and `node.port` to the default node address.
+
+- Configure the optional extension for [Cesium+](https://git.duniter.org/clients/cesium-grp/cesium-plus-pod/)
+
+ * set `plugins.es.host` and `plugins.es.port` to the default Cesium+ Pod (aka ES) address.
+ * set `plugins.es.enable` with [true|false] to change the default extension state.
+
+
+To learn more about configuration options, see the [detailed documentation](configuration.md).
+
+
+##Â Update to the last version
+
+On Linux server, you can use an update script:
+
+```
+cd <CESIUM_WEB_ROOT>
+curl -kL https://git.duniter.org/clients/cesium-grp/cesium/raw/master/install.sh | bash
+```
+or:
+
+```
+cd <CESIUM_WEB_ROOT>
+wget -qO- https://git.duniter.org/clients/cesium-grp/cesium/raw/master/install.sh | bash
+```
+
+> **Note**: You should NOT need root permission. Make sure to NEVER replace `| bash` by `| sudo bash`!
+> For any permission issue during installation, change permission on directory, then retry.
+
+## Another Bash script
This is a bash script example, that you can use to deploy the latest release, in a existing Cesium web site.
--
GitLab