Visit [ucoin.io](http://ucoin.io) website: it gathers theoretical informations, FAQ and several useful links. If you want to learn, this is the first place to visit.

**Universal Dividend - by people, for people**

### Talk about/get involved in uCoin project

uCoin uses [Human Dividend Currency format](https://github.com/ucoin-io/ucoin/blob/master/doc/HDC.md) to describe the monetary system, where money is issued directly and exclusively **by** individuals of the Community to themselves. Individuals are the only ones who may issue new money, and choose the unities they desire : this is a monetary system where **U** coin.

If you wish to participate/debate on uCoin, you can:

**Democratic**

In a uCoin currency, money is legitimated by collectively signed documents. *De facto*, uCoin implies a democratical process in money issuance and community membership.

**Humanity scale compliant**

uCoin uses a distribution system for its transactions database, allowing for potentially humanity scale currencies. Indeed, billions of people making together millions of transactions per second is not likely to be handled by every unit of a PC made network. That is why uCoin transactions database is distributed.

Wizard is composed of 4 steps: `currency`, `openpgp`, `network`, `key`. By adding one of those words to `wizard` command, you will only do the attached steps:

```bash

$ ucoind wizard network

[?] IPv4 interface: wlan1 192.168.1.14

[?] IPv6 interface: wlan1 2a01:e35:8a37:f2b0:dd48:5620:5d3c:ce2c

[?] Port: 8080

[?] Remote IPv4 88.163.127.43

[?] Remote IPv6 None

[?] Remote port: 9101

[2014-05-19 17:32:46.799] [DEBUG] ucoind - Configuration saved.

```

### Launching the node

Finally, you just need to use `start` command to launch the node:

```bash

$ ucoind start

[2014-05-19 17:42:33.494] [DEBUG] service - Loaded service: Contract

...

[2014-05-19 17:42:33.613] [DEBUG] ucoind - Server ready!

```

### Change of database

The default database name is "ucoin_default". Thus, when using any command, the targeted database is "ucoin_default".

To deal with another database, just add `--mdb` parameter:

```bash

$ ucoind --mdb mycurrency wizard

```

This will launch wizard on `mycurrency` database *only*.

### Manual configuration

You might also want to do your configuration manually, using CLI options. [Here is a document](./doc/manual-config.md) on how to achieve this.

### Initial data

Once your server is running, it is already usable. However, at this step, you have 2 choices: you might either want to create your brand new currency with fresh new data, or just want to add your node to an already existing currency. Below are how to do each.

#### Brand new currency

You should follow [this gist](https://gist.github.com/c-geek/6343172) which explains how to use [ucoin-cli](https://github.com/ucoin-io/ucoin-cli) software, allowing to add your first keys, create your initial Monetary Contract and make transactions.

#### Existing currency

In this cas, you need to synchronize with existing peers to fetch existing:

* Public keys

* Monetary Contract

* Transactions

* Peers

* Trust Hash Table

This is easily done with:

```bash

$ ucoind sync <host_name> <port>

```

For example, to synchronise with [ucoin.twiced.fr:9101](http://ucoin.twiced.fr:9101/network/peering):

```bash

$ ucoind sync ucoin.twiced.fr 9101

[2014-01-07 23:21:52.571] [INFO] sync - Sync started.

...

[2014-01-07 23:21:52.997] [INFO] sync - Sync finished.

```

Your node is then ready to be started, making it contact all known peers to introduce itself and exchange peering informations.

### Help

For more more details on the ucoin command, run:

ucoind --help

Which displays:

```

Usage: ucoind <command> [options]

Commands:

sync [host] [port] Tries to synchronise data with remote uCoin node

allow-key [key] Add given key to authorized keys of this node

manage-key [key] Add given key to stack of managed keys of this node

forget-key [key] Remove given key of the managed keys' stack of this node

config Register configuration in database

reset [config|data] Reset configuration or data in database

start Start uCoin server using given --currency

Options:

-h, --help output usage information

-V, --version output the version number

-p, --port <port> Port to listen for requests

-c, --currency <name> Name of the currency managed by this node.

--mhost <host> MongoDB host.

--mport <port> MongoDB port.

-d, --mdb <name> MongoDB database name (defaults to "ucoin_default").

--pgpkey <keyPath> Path to the private key used for signing HTTP responses.

--pgppasswd <password> Password for the key provided with --httpgp-key option.

--ipv4 <address> IPV4 interface to listen for requests

--ipv6 <address> IPV6 interface to listen for requests

--remoteh <host> Remote interface others may use to contact this node

--remote4 <host> Remote interface for IPv4 access

--remote6 <host> Remote interface for IPv6 access

--remotep <port> Remote port others may use to contact this node

--kmanagement <ALL|KEYS> Define key management policy

--kaccept <ALL|KEYS> Define key acceptance policy

```

## Talk about/get involved in uCoin project

For the moment uCoin is developed only by its author. If you wish to participate/debate on it, you can: