politeiad

README

politeiad

Installing and running

Install dependencies

MySQL/MariaDB

Installation instructions can be found at the links below. MySQL: https://www.mysql.com MariaDB: https://mariadb.com

Build from source

1. Set the password for the MySQL root user and update the MySQL max connections settings.

   Max connections defaults to 151 which is not enough for trillian. You will be prompted for the MySQL root user's password when running these commands.

   # Update max connections    
   $ mysql -u root -p -e "SET GLOBAL max_connections = 2000;"
   
   # Verify the setting
   $ mysql -u root -p -e "SHOW VARIABLES LIKE 'max_connections';"
   

   You can also update the config file so you don't need to set it manually in the future. Make sure to restart MySQL once you update the config file.

   MariaDB config file: /etc/mysql/mariadb.cnf
   MySQL config file: /etc/mysql/my.cnf

   [mysqld]
   max_connections = 2000
   

2. Install trillian v1.3.13.

   $ mkdir -p $GOPATH/src/github.com/google/
   $ cd $GOPATH/src/github.com/google/
   $ git clone git@github.com:google/trillian.git
   $ cd trillian
   $ git checkout tags/v1.3.13 -b v1.3.13
   $ go install -v ./...
   

3. Install politeia.

   $ mkdir -p $GOPATH/src/github.com/decred
   $ cd $GOPATH/src/github.com/decred
   $ git clone git@github.com:decred/politeia.git
   $ cd politeia
   $ go install -v ./...
   

4. Run the politeiad mysql setup scripts.

   This will create the politeiad and trillian users as well as creating the politeiad databases. Password authentication is used for all database connections.

   The password that you set for the politeiad MySQL user will be used to derive an encryption key that is used to encrypt non-public data at rest. Make sure to setup a strong password when running in production. Once set, the politeiad user password cannot change.

   The setup script assumes MySQL is running on localhost:3306 and the users will be accessing the databse from localhost. See the setup script comments for more complex setups.

   Run the following commands. You will need to replace rootpass with the existing password of your root user. The politeiadpass and trillianpass are the password that will be set for the politeiad and trillian users when the script creates them.

   $ cd $GOPATH/src/github.com/decred/politeia/politeiad/scripts
   $ env \
     MYSQL_ROOT_PASSWORD=rootpass \
     MYSQL_POLITEIAD_PASSWORD=politeiadpass \
     MYSQL_TRILLIAN_PASSWORD=trillianpass \
     ./tstore-mysql-setup.sh
   

5. Run the trillian mysql setup scripts.

   These can only be run once the trillian MySQL user has been created in the previous step.

   The trillianpass and rootpass will need to be updated to the passwords for your trillian and root users.

   If setting up a mainnet instance, change the MYSQL_DATABASE env variable to mainnet_trillian.

   $ cd $GOPATH/src/github.com/google/trillian/scripts
   
   # Testnet setup
   $ env \
     MYSQL_USER=trillian \
     MYSQL_PASSWORD=trillianpass \
     MYSQL_DATABASE=testnet3_trillian \
     MYSQL_URI="${MYSQL_USER}:${MYSQL_PASSWORD}@tcp(127.0.0.1:3306)/${MYSQL_DATABASE}" \
     MYSQL_ROOT_PASSWORD=rootpass \
     ./resetdb.sh
   

6. Start up the trillian instances.

   Running trillian requires running a trillian log server and a trillian log signer. These are seperate processes that will be started in this step.

   You will need to replace the trillianpass with the trillian user's password that you setup in previous steps. The commands below for testnet and mainnet run the trillian instances on the same ports so you can only run one set of commands, testnet or mainnet. Run the testnet commands if you're setting up a development environment.

   If setting up a mainnet instance, change the MYSQL_DATABASE env variable to mainnet_trillian for both the log server and log signer.

   Start testnet log server

   $ export MYSQL_USER=trillian && \
     export MYSQL_PASSWORD=trillianpass && \
     export MYSQL_DATABASE=testnet3_trillian && \
     export MYSQL_URI="${MYSQL_USER}:${MYSQL_PASSWORD}@tcp(127.0.0.1:3306)/${MYSQL_DATABASE}"
   
   $ trillian_log_server \
     --mysql_uri=${MYSQL_URI} \
     --mysql_max_conns=2000 \
     --rpc_endpoint localhost:8090 \
     --http_endpoint localhost:8091 \
     --logtostderr ...
   

   Start testnet log signer

   $ export MYSQL_USER=trillian && \
     export MYSQL_PASSWORD=trillianpass && \
     export MYSQL_DATABASE=testnet3_trillian && \
     export MYSQL_URI="${MYSQL_USER}:${MYSQL_PASSWORD}@tcp(127.0.0.1:3306)/${MYSQL_DATABASE}"
   
   $ trillian_log_signer --logtostderr --force_master \
     --batch_size=1000 \
     --sequencer_guard_window=0 \
     --sequencer_interval=200ms \
     --mysql_uri=${MYSQL_URI} \
     --rpc_endpoint localhost:8092 \
     --http_endpoint=localhost:8093 
   

7. Setup the politeiad configuration file.

   sample-politeiad.conf

   Copy the sample configuration file to the politeiad app data directory. The app data directory will depend on your OS.

   • macOS

     /Users/<username>/Library/Application Support/Politeiad/politeiad.conf

   • Windows

     C:\Users\<username>\AppData\Local\Politeiad/politeiad.conf

   • Unix

     ~/.politeiad/politeiad.conf

   $ mkdir -p ${HOME}/.politeiad/
   $ cd $GOPATH/src/github.com/decred/politeia/politeiad
   $ cp ./sample-politeiad.conf ${HOME}/.politeiad/politeiad.conf
   

   Use the following config settings to spin up a development politeiad instance.

   politeiad.conf

   rpcuser=user
   rpcpass=pass
   testnet=true
   
   ; Tstore settings
   dbtype=mysql
   
   ; Pi plugin configuration
   plugin=pi
   plugin=comments
   plugin=dcrdata
   plugin=ticketvote
   plugin=usermd
   

8. Start up the politeiad instance.

   The password for the politeiad MySQL user must be provided in the DBPASS env variable. The encryption key used to encrypt non-public data at rest will be derived from the DBPASS. The DBPASS cannot change.

   A password to derive the trillian signing key must be provided in the TLOGPASS env variable. This password has not been created yet. You can set it to whatever you want, but it cannot change once set.

   $ env DBPASS=politeiadpass TLOGPASS=tlogpass politeiad
   

Tools and reference clients

• politeia - Reference client for politeiad.

Documentation

Overview

Copyright (c) 2020-2021 The Decred developers Use of this source code is governed by an ISC license that can be found in the LICENSE file.

Copyright (c) 2020-2021 The Decred developers Use of this source code is governed by an ISC license that can be found in the LICENSE file.