Skip to content

Commit

Permalink
Added README for zeroname plugin with instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rllola committed Feb 12, 2019
1 parent 523f8da commit c006017
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions plugins/Zeroname/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# ZeroName

Zeroname plugin to connect Namecoin and register all the .bit domain name.

## Start

You can create your own Zeroname.

### Namecoin node

You need to run a namecoin node.

[Namecoin](https://namecoin.org/download/)

You will need to start it as a RPC server.

Example of `~/.namecoin/namecoin.conf` minimal setup:
```
daemon=1
rpcuser=your-name
rpcpassword=your-password
rpcport=8336
server=1
txindex=1
```

Don't forget to change the `rpcuser` value and `rpcpassword` value!

You can start your node : `./namecoind`

### Update `updater/zeroname_updater.py`


You need update lines 117-118 with the correct `rpcuser` and `rpcpassword`.
```
'user': 'PLACEHOLDER',
'password': 'PLACEHOLDER',
```

You will also need to create a site `python zeronet.py createSite` and regitser the info.

In the site you will need to create a file `./data/<your-site>/data/names.json` with this is it:
```
{}
```

### `zeroname_config.json` file

In `~/.namecoin/zeroname_config.json`
```
{
"lastprocessed": 223910,
"zeronet_path": "/root/ZeroNet", # Update with your path
"privatekey": "", # Update with your private key of your site
"site": "" # Update with the address of your site
}
```

### Run updater

You can now run the script : `updater/zeroname_updater.py` and wait until it is fully sync (it might take a while).

0 comments on commit c006017

Please sign in to comment.