README.md 3.75 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
[Unhosted webapp](https://unhosted.org) client for any [Duniter](https://duniter.org) crypto-currency.
Cédric Moreau's avatar
README    
Cédric Moreau committed
6

Benoit Lavenier's avatar
Benoit Lavenier committed
7
8
9
10
11
Manage your wallet, certify your friends, and more ! 


## Try it !

Benoit Lavenier's avatar
Benoit Lavenier committed
12
 - on Ğ1-test currency: https://g1-test.duniter.fr
Benoit Lavenier's avatar
Benoit Lavenier committed
13
 - on Ğ1 currency (production use): https://g1.duniter.fr
Benoit Lavenier's avatar
Benoit Lavenier committed
14

Moul's avatar
Moul committed
15

16
17
## Installation

18
### On a desktop computer
19
20
21
 
 To use Cesium from your desktop computer :
 
Benoit Lavenier's avatar
Benoit Lavenier committed
22
23
24
25
26
27
28
29
 - Debian or Windows: 
    * Download the [latest release](https://github.com/duniter/cesium/releases/latest).
    * Choose the desktop packaging (`cesium-desktop-vX.Y.Z-*`)
    * Execute the downloaded file, and follow installation steps;
 - Other operating systems: 
    * Choose the web packaging (`cesium-vX.Y.Z-web.zip`);
    * Unpack the archive into a empty folder;
    * Open the file `index.html` in your web browser;
30
31
32
33
34
35
36
37

### On a Yunohost installation

There is a [package](https://github.com/duniter/cesium_ynh) for [YunoHost self-hosting distribution](https://yunohost.org).

### On a web server

#### Installation
38

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

Benoit Lavenier's avatar
Benoit Lavenier committed
41
42
43
 - Download the [latest release](https://github.com/duniter/cesium/releases/latest). Choose the web packaging (`cesium-vX.Y.Z-web.zip`); 
 - Unpack in a empty directory;
 - Configure a virtual host, to use previous directory as root. Check the file `index.html` exist in the root directory.
Millicent Billette's avatar
Millicent Billette committed
44

Benoit Lavenier's avatar
Benoit Lavenier committed
45
For Linux distribution, a installation script could also be used to:
46

47
48
 - Download the [latest release](https://github.com/duniter/cesium/releases/latest)
 - Unpack archive into the directory `./cesium`. Existing files will be override.  
49
50

```
51
curl -kL https://git.duniter.org/clients/cesium-grp/cesium/raw/master/install.sh | bash
52
53
54
55
```
or:

```
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
63
64
#### Configuration

To change default configuration, on a web server installation:
65
66
67

  - Edit the file `config.js`, and set default properties:
  
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
83
84
85
  "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": "gtest.duniter.org",
    "port": "10900"
  },
86
87
88
	"plugins": {
		"es": {
			"enable": "false",
89
			"host": "data.gtest.duniter.fr",
Benoit Lavenier's avatar
Benoit Lavenier committed
90
			"port": "80"
91
92
		}
	},
93
	"version": "0.9.7",
Benoit Lavenier's avatar
Benoit Lavenier committed
94
	"build": "2017-01-17T08:27:57.915Z"
95
96
97
98
99
100
101
102
103
104
105
106
107
});
```

  - Configure a Duniter node:
 
     * set `node.host` and `node.port` to the default node address. 
   
  - Configure the optional extension for [ElasticSearch Duniter4j node](https://github.com/duniter/duniter4j)
 
     * set `plugins.es.host` and `plugins.es.port` to the default ES node address.
   
     * 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
 
110
## Developement
111

112
Wants to compile Cesium ? or contribute ?
113

114
115
116
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
117
 
118
A [development tutorial](doc/fr/development_tutorial-01.md) (in French) is also available.
119

120
## License
121

122
This software is distributed under [GNU AGPL-3.0](https://raw.github.com/duniter/cesium/master/LICENSE).
123
124
125
126
127
128
129
130
131
132

## Troubleshooting

#### I'm having errors on Ubuntu/Debian (desktop version)

Install these dependencies:

```
sudo apt-get install -y libgconf-2-4
```