Skip to content

Commit c006017

Browse files
committed
Added README for zeroname plugin with instructions
1 parent 523f8da commit c006017

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

plugins/Zeroname/README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# ZeroName
2+
3+
Zeroname plugin to connect Namecoin and register all the .bit domain name.
4+
5+
## Start
6+
7+
You can create your own Zeroname.
8+
9+
### Namecoin node
10+
11+
You need to run a namecoin node.
12+
13+
[Namecoin](https://namecoin.org/download/)
14+
15+
You will need to start it as a RPC server.
16+
17+
Example of `~/.namecoin/namecoin.conf` minimal setup:
18+
```
19+
daemon=1
20+
rpcuser=your-name
21+
rpcpassword=your-password
22+
rpcport=8336
23+
server=1
24+
txindex=1
25+
```
26+
27+
Don't forget to change the `rpcuser` value and `rpcpassword` value!
28+
29+
You can start your node : `./namecoind`
30+
31+
### Update `updater/zeroname_updater.py`
32+
33+
34+
You need update lines 117-118 with the correct `rpcuser` and `rpcpassword`.
35+
```
36+
'user': 'PLACEHOLDER',
37+
'password': 'PLACEHOLDER',
38+
```
39+
40+
You will also need to create a site `python zeronet.py createSite` and regitser the info.
41+
42+
In the site you will need to create a file `./data/<your-site>/data/names.json` with this is it:
43+
```
44+
{}
45+
```
46+
47+
### `zeroname_config.json` file
48+
49+
In `~/.namecoin/zeroname_config.json`
50+
```
51+
{
52+
"lastprocessed": 223910,
53+
"zeronet_path": "/root/ZeroNet", # Update with your path
54+
"privatekey": "", # Update with your private key of your site
55+
"site": "" # Update with the address of your site
56+
}
57+
```
58+
59+
### Run updater
60+
61+
You can now run the script : `updater/zeroname_updater.py` and wait until it is fully sync (it might take a while).

0 commit comments

Comments
 (0)