Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
243 changes: 106 additions & 137 deletions HOWTO.md

Large diffs are not rendered by default.

54 changes: 29 additions & 25 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,47 @@ detailed information on how to configure your server.


TLDR:
$ sudo ./configure
$ sudo python ./setup.py install
$ electrum-server start
$ electrum-server stop
# sudo apt-get install git
# sudo git clone https://github.com/sherlockcoin/electrum-navcoin-server
# sudo apt-get install libleveldb-dev
# sudo ./configure
# sudo python ./setup.py install
# electrum-navcoin-server start
# electrum-navcoin-server stop


Note: If you want to run the server without installing it on your
system, just run 'run_electrum_server"
system, just run 'run_electrum_navcoin_server"


1. Install and run bitcoind.
1. Install and run navcoind.
----------------------------

You will need to run bitcoind with the config option txindex=1. If you
have not previously done so, you may need to reindex the bitcoind
You will need to run navcoind with the config option txindex=1. If you
have not previously done so, you may need to reindex the navcoind
blockchain

Note: you cannot use a pruning bitcoind. A full bitcoin node is
required in order to know for each address if it has been
used. Pruning occurs only at the level of the Electrum database.
Note: you cannot use a ultra-pruning navcoind (forthcoming in 0.9 or
later). A full navcoin node is required in order to know for each
address if it has been used. Pruning occurs only at the level of the
Electrum database.


2. Run the 'configure' script
---------------------------
You need to run the script as root:

$ sudo ./configure
# sudo ./configure

It will:
* create the configuration file in /etc/electrum.conf
* create the configuration file in /etc/electrum-navcoin.conf
* create a user that will run the daemon
* optionally, download a fresh database from the Electrum Foundry.
* optionally, download a fresh database from the Electrum-NAVCOIN Foundry.

If you choose not to use the Foundry, your server will have to build
the database from scratch. This process can take several days. To
speed it up, it is recommended to locate your database in shared
memory, in electrum.conf: path = /run/shm/electrum_db
memory, in electrum-navcoin.conf: path = /run/shm/electrum-navcoin_db

Note: The 'configure' script does not configure SSL and IRC. You will
need to manually edit the configuration file in order to enable SSL on
Expand All @@ -49,39 +53,39 @@ your server, and to be visible on IRC.
3. Install the python package
-----------------------------

$ sudo python setup.py install
# sudo python setup.py install

Note: You will need to redo this everytime you pull code from git.


4. Using the server
-------------------

Use 'electrum-server' to start and stop the server:
Use 'electrum-navcoin-server' to start and stop the server:

$ electrum-server <start|stop|status|getinfo>
# electrum-navcoin-server <start|stop|status|getinfo>

The server will write a log file in its database path.


5. Add electrum-server to your system's services
------------------------------------------------
5. Add electrum-navcoin-server to your system's services
----------------------------------------------------

If your system supports it, you may add electrum-server to the
If your system supports it, you may add electrum-navcoin-server to the
/etc/init.d directory. This will ensure that the server is started and
stopped automatically, and that the database is closed safely whenever
your machine is rebooted.

# ln -s `which electrum-server` /etc/init.d/electrum-server
# update-rc.d electrum-server defaults
# ln -s `which electrum-navcoin-server` /etc/init.d/electrum-navcoin-server
# update-rc.d electrum-navcoin-server defaults



6. Troubleshooting:
-------------------

* if your server or bitcoind is killed because is uses too much
memory, configure bitcoind to limit the number of connections
* if your server or navcoind is killed because is uses too much
memory, configure navcoind to limit the number of connections

* if you see "Too many open files" errors, you may need to increase
your user's File Descriptors limit. For this, see
Expand Down
Loading