README.md 3.99 KB
Newer Older
1
![Cesium logo](https://github.com/duniter/cesium/raw/master/www/img/logo_144px.png)
Moul's avatar
Moul committed
2

Cédric Moreau's avatar
README  
Cédric Moreau committed
3 4
# Cesium

Benoit Lavenier's avatar
Benoit Lavenier committed
5 6 7
 - [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)
Cédric Moreau's avatar
README  
Cédric Moreau committed
8

Benoit Lavenier's avatar
Benoit Lavenier committed
9
## Install
Benoit Lavenier's avatar
Benoit Lavenier committed
10

Benoit Lavenier's avatar
Benoit Lavenier committed
11
### On desktop computer
Benoit Lavenier's avatar
Benoit Lavenier committed
12

Benoit Lavenier's avatar
Benoit Lavenier committed
13
 - Download the [latest release](https://github.com/duniter/cesium/releases/latest)
14
 
Benoit Lavenier's avatar
Benoit Lavenier committed
15 16 17 18 19 20 21 22
 - Then install, depending on your operating system:  
    * Ubuntu: Double click the `.deb` file
    * Debian: Run the command `sudo dpkg -i *.deb`
    * Windows: Double click on the `.exe` file
    * Mac OSx: Unzip the osx `.zip` file, then drop Cesium into your `Applications` folder 
    * Other operating systems:  
       * Unpack the ZIP archive (file `cesium-vX.Y.Z-web.zip`) into an empty folder;
       * Open the file `index.html` in your web browser;
23

Benoit Lavenier's avatar
Benoit Lavenier committed
24
### On smartphone
25

Benoit Lavenier's avatar
Benoit Lavenier committed
26 27 28 29 30
 - Android: 
    * Manual installation: download then install the `.apk` from your smartphone;
    * [Play Store](https://play.google.com/store/apps/details?id=fr.duniter.cesium);
 - iOS
    * Coming soon...;
31

Benoit Lavenier's avatar
Benoit Lavenier committed
32
### As a web site
33

Benoit Lavenier's avatar
Benoit Lavenier committed
34
#### First installation
35

Benoit Lavenier's avatar
Benoit Lavenier committed
36
Cesium can be easily installed on most web server : 
37

Benoit Lavenier's avatar
Benoit Lavenier committed
38 39 40 41 42
 - 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.
Millicent Billette's avatar
Millicent Billette committed
43

Benoit Lavenier's avatar
Benoit Lavenier committed
44
#### Update to last version
45

Benoit Lavenier's avatar
Benoit Lavenier committed
46
On Linux distributions, an update script can be used to update your Cesium web site:
47 48

```
Benoit Lavenier's avatar
Benoit Lavenier committed
49
cd <CESIUM_WEB_ROOT>
50
curl -kL https://git.duniter.org/clients/cesium-grp/cesium/raw/master/install.sh | bash
51 52 53 54
```
or:

```
Benoit Lavenier's avatar
Benoit Lavenier committed
55
cd <CESIUM_WEB_ROOT>
56
wget -qO- https://git.duniter.org/clients/cesium-grp/cesium/raw/master/install.sh | bash
57 58 59
```


Benoit Lavenier's avatar
Fix doc  
Benoit Lavenier committed
60
**Note**: You may need root permission to write files. If so just replace `| bash` with `| sudo bash`.
61

Benoit Lavenier's avatar
Benoit Lavenier committed
62
#### Changing default settings 
Benoit Lavenier's avatar
Benoit Lavenier committed
63

Benoit Lavenier's avatar
Benoit Lavenier committed
64
To change default configuration, on a Cesium web site:
65

Benoit Lavenier's avatar
Benoit Lavenier committed
66
  - Edit the file `config.js` in the web root directory, and change some properties:
67
  
Benoit Lavenier's avatar
Benoit Lavenier committed
68
```js
69 70
angular.module("cesium.config", [])
.constant("csConfig", {
71 72 73 74 75 76 77 78 79 80 81 82
  "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": {
Benoit Lavenier's avatar
Benoit Lavenier committed
83 84
    "host": "g1.duniter.org",
    "port": "443"
85
  },
86 87
	"plugins": {
		"es": {
Benoit Lavenier's avatar
Benoit Lavenier committed
88 89 90
			"enable": "true",
			"host": "g1.data.duniter.fr",
			"port": "443"
91 92
		}
	},
Benoit Lavenier's avatar
Benoit Lavenier committed
93 94
	"version": "1.3.7",
	"build": "2019-04-02T08:27:57.915Z"
95 96 97 98 99 100 101
});
```

  - Configure a Duniter node:
 
     * set `node.host` and `node.port` to the default node address. 
   
Benoit Lavenier's avatar
Benoit Lavenier committed
102
  - Configure the optional extension for [Cesium+](https://git.duniter.org/clients/cesium-grp/cesium-plus-pod/)
103
 
Benoit Lavenier's avatar
Benoit Lavenier committed
104
     * set `plugins.es.host` and `plugins.es.port` to the default Cesium+ Pod (aka ES) address.
105 106 107
   
     * set `plugins.es.enable` with [true|false] to change the default extension state. 
   
Benoit Lavenier's avatar
Benoit Lavenier committed
108
To learn more about configuration options, see the [detailed documentation](doc/configuration.md).
109
 
Benoit Lavenier's avatar
Benoit Lavenier committed
110 111 112
#### Yunohost package
    
There is a [package](https://github.com/duniter/cesium_ynh) for [YunoHost self-hosting distribution](https://yunohost.org).
113

Benoit Lavenier's avatar
Benoit Lavenier committed
114
## Contribute
115

116 117 118
A [Development Guide](doc/development_guide.md) is available to learn :
 - How to install your development environment.
 - Development best practices.
Benoit Lavenier's avatar
Benoit Lavenier committed
119
 
120
A [development tutorial](doc/fr/development_tutorial-01.md) (in French) is also available.
121

Benoit Lavenier's avatar
Benoit Lavenier committed
122
## Donate
123

Benoit Lavenier's avatar
Benoit Lavenier committed
124
To help developers with donation, use the [Cesium Team Ğ1 account](https://g1.duniter.fr#/app/wot/CitdnuQgZ45tNFCagay7Wh12gwwHM8VLej1sWmfHWnQX/) (public key: `CitdnuQgZ45tNFCagay7Wh12gwwHM8VLej1sWmfHWnQX`) 
125

Benoit Lavenier's avatar
Benoit Lavenier committed
126
## License
127

Benoit Lavenier's avatar
Benoit Lavenier committed
128
This software is distributed under [GNU AGPL-3.0](https://raw.github.com/duniter/cesium/master/LICENSE).