Giters

bosagora / votera-server

Votera Server

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Votera Server

installation

votera server is using strapi with node

votera server is using strapi with node server it requires version 14 or later.

Required module and package

  1. mysql : used as database
  2. redis : used for pubsub and redlock
  3. s3 : used as file upload repository

configuration location and list

mysql

config location: config/database.js

reference strapi database configuration

  • connections List of all available connections.
    • default
      • connector (string): Connector used by the current connection. Will be bookshelf.
      • settings Useful for external session stores such as Redis.
        • client (string): Database client to create the connection. sqlite or postgres or mysql.
        • host (string): Database host name. Default value: localhost.
        • port (integer): Database port.
        • database (string): Database name.
        • username (string): Username used to establish the connection.
        • password (string): Password used to establish the connection.
        • timezone (string): Set the default behavior for local time. Default value: utc Timezone options
        • schema (string): Set the default database schema. Used only for Postgres DB.
        • ssl (boolean/object): For ssl database connection. Object is used to pass certificate files as strings.
      • options Options used for database connection.
        • debug (boolean): Show database exchanges and errors.
        • autoMigration (boolean): To disable auto tables/columns creation for SQL database.
        • pool Options used for database connection pooling. For default value and more information, look at Knex's pool config documentation
          • min (integer): Minimum number of connections to keep in the pool.
          • max (integer): Maximum number of connections to keep in the pool.
          • acquireTimeoutMillis (integer): Maximum time in milliseconds to wait for acquiring a connection from the pool.
          • createTimeoutMillis (integer): Maximum time in milliseconds to wait for creating a connection to be added to the pool.
          • idleTimeoutMillis (integer): Number of milliseconds to wait before destroying idle connections.
          • reapIntervalMillis (integer): How often to check for idle connections in milliseconds.
          • createRetryIntervalMillis (integer): How long to idle after a failed create before trying again in milliseconds.

redis (pubsub)

config location : config/pubsub.js

  • service
    • enable : enable/disable pubsub
    • endpoint: url of pubsub
  • redis (redis configuration for pubsub feature)
    • enable : enable/disable redis use for pubsub
    • options
      • host : redis host
      • port : redis port
      • username : username for redis connection
      • password : password for redis connection

redis (cron redlock) and others for server

config location: config/server.js

  • host: service ip of strapi server
  • port: listening port of strapi server
  • contact:
    • support: support contact information
  • cron: cron configuration
    • enabled: enable/disable cron service
    • redis: configuration for cron redlock
      • enable: enable/disable for redis for cron
      • options: cron redlock connection information
        • host : redis host
        • port : redis port
        • username : username for redis connection
        • password : password for redis connection
    • ttl: ttl (time to live) configuration of redlock
    • feedExpireDays: expires feeds after this days
  • admin: server admin setting
    • auth:
      • secret: admin page JWT secret key

s3 (upload configuration)

config location : config/plugins.js

can use other upload provider of strapi

Strapi upload

  • upload : Upload plugin configuration
    • provider : Upload plugin name
    • providerOptions :
      • accessKeyId : S3 Access Key ID
      • secretAccessKey : S3 Secret Access Key
      • region : S3 service region
      • params
        • Bucket : S3 Service bucket

Bosagora configuration

config location: config/boaclient.js

Bosagora Blockchain configuration

  • chainId : agora chain id
  • providerUrl : agora json rpc provider url
  • query
    • url : validator rpc query server url
    • pageSize : validator query page size
  • signValidTime : signTypeData signature valid time interval
  • wallet
    • path : votera server wallet json path
    • password : votera server wallet password
    • voteKey : votera server private key (wallet ignored)
  • contract
    • commonsBudget : address of commons budget contract
    • voteraVote : address of votera vote contract
    • validatorSize : size of validators to contract call addvalidators
    • revealBallotSize : size of ballot to contract call revealBallot
  • transaction_wait : provider waitForTransaction time (in milliseconds)
  • hmacKey : hmac key for voteBox seal key

Votera configuration

config location: config/votera.js

Votera service configuration

  • proposalInfoUrl : proposal information url
  • services
    • assess_begin_offset : assess begin offset in seconds (from GMT+9)
    • assess_end_offset : assess end date offset in seconds (from GMT+9)
    • vote_begin_offset : vote begin date offset in seconds (from GMT+9)
    • vote_end_offset : vote end date offset in seconds (from GMT+9)
    • vote_open : vote open after vote_end
    • can_withdraw_after : withdraw after vote end in seconds
  • report
    • reportMinCount : minimum count for report
    • reportPercent : percent of member for report

Votera Strapi Configuration

Votera Server (Using strapi server)

Method for Authenticated permission

Plugin Name Method
Application Agora find
Application Ballot listMyBallots,recordBallot,submitBallot
Application Feeds count, feedsStatus, find, findone, listFeeds, update
Application Member all
Application Post all
Application Proposal all
Application Transaction updateReceipt
Application Validator all
Application Version find
Upload Upload upload
Users-Permissions User me, updateuseralarmstatus, updateuserpushtoken

method for Public permission

Plugin Name Method
Application Agora find
Application Member all
Application Post all
Application Proposal all
Application Transaction updateReceipt
Application Validator all
Application Version find
Users-Permissions Auth callback, connect, emailconfirmation, forgotpassword, register, resetpassword
Users-Permissions User me

Agora

Field Description
PrivacyTermUrl url for privacy policy
UserServiceTermUrl url for user service policy
CommonsBudgetAddress address of commons budget contract
ProposalFundMin 1
ProposalFundMax
VoteraVoteAddress address of votera vote contract
ProviderUrl address of blockchain provider

.env variable

Name Description Default
HOST binding 할 서버 주소 0.0.0.0
PORT 서비스 포트 1337
DATABASE_HOST mysql database host localhost
DATABASE_PORT mysql database port 3306
DATABASE_NAME mysql database name
DATABASE_USERNAME mysql connect username
DATABASE_PASSWORD mysql connect password
PUBSUB_ENABLE pubsub 기능 on/off false
PUBSUB_ENDPOINT pubsub endpoint url /subscriptions
PUBSUB_REDIS_ENABLE redis를 이용한 pubsub on/off false
PUBSUB_REDIS_HOST redis를 이용한 pubsub 일 경우 REDIS host
PUBSUB_REDIS_PORT redis를 이용한 pubsub 일 경우 REDIS port 6379
PUBSUB_REDIS_USERNAME redis 접속시 username
PUBSUB_REDIS_PASSWORD redis 접속 시 password
CRON_REDIS_ENABLE redlock를 이용한 cron batch job control on/off false
CRON_REDIS_HOST redlock 이용할 경우 redis host
CRON_REDIS_PORT redlock 이용할 경우 redis port 6379
CRON_REDIS_USERNAME redlock 이용할 경우 redis username
CRON_REDIS_PASSWORD redlock 이용할 경우 redis password
CRON_LOCK_TTL cron lock time to live time 300
CRON_FEED_EXPIRE_DAYS delete feed after days 90
ADMIN_JWT_SECRET Admin JWT Token secret key
AWS_S3_ACCESS_KEY_ID AWS S3 Access Key
AWS_S3_SECRET_ACCESS_KEY AWS S3 access secret key
AWS_S3_REGION AWS S3 region
AWS_S3_BUCKET AWS S3 bucket
BOSAGORA_CHAINID agora chain id 2020
BOSAGORA_PROVIDER_URL agora json rpc provider url
BOSAGORA_QUERY_URL validator rpc query server url
BOSAGORA_QUERY_PAGE_SIZE validator query page size 1000
BOSAGORA_SIGN_VALID_TIME signTypeData signature valid time interval (in milliseconds) 600000
WALLET_PATH votera server wallet json path
WALLET_PASSWORD votera server wallet password
WALLET_VOTE_KEY votera server private key (wallet path and password) ignored)
COMMONS_BUDGET_ADDRESS address of commons budget contract
VOTERA_VOTE_ADDRESS address of votera vote contract
VOTERA_VOTE_VALIDATOR_SIZE size of validators to contract call addvalidators 100
VOTERA_VOTE_REVEALBALLOT_SIZE size of ballot to contract call revealBallot 100
TRANSACTION_WAIT_TIME provider waitForTransaction time (in milliseconds) 30000
HMAC_KEY hmac key for voteBox seal key
PROPOSAL_INFO_HOST proposal information url host
ASSESS_BEGIN_OFFSET assess begin offset in seconds (from GMT+9) 0
ASSESS_END_OFFSET assess end date offset in seconds (from GMT+9) 86399
VOTE_BEGIN_OFFSET vote begin date offset in seconds (from GMT+9) 0
VOTE_END_OFFSET vote end date offset in seconds (from GMT+9) 86399
VOTE_OPEN_TIME vote open after vote_end in seconds 30
WITHDRAW_AFTER withdraw after vote end in seconds 86400
VOTERA_REPORT_MINCOUNT minimum count for report 10
VOTERA_REPORT_PERCENT percent of member for report 10
VOTERA_HOME_HOST votera user page url for cors http://localhost
VOTERA_ADMIN_HOST votera admin page url for cors http://localhost:1337

Installation

  1. package update

    sudo apt update
sudo apt upgrade

  2. nvm install

    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

    or

    wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

  3. install node

    nvm install lts/fermium

  4. update npm

    npm install -g npm
npm install -g corepack

  5. install nginx

    sudo apt install nginx

  6. download votera-server

    cd ~
mkdir votera
cd votera
git clone https://github.com/bosagora/votera-server.git

  7. build votera-server

    cd ~/votera/votera-server
yarn install
yarn build

    아래부터는 다음 참조

    AWS Deployment - Strapi Developer Documentation

  8. install pm2

    cd ~
npm install -g pm2

  9. start pm2

    cd ~
pm2 init
vi ecosystem.config.js

  10. edit ecosystem.config.js

    다음과 같은 사항이면 된다.

    module.exports = {
  apps : [{
    name: 'votera-server',
    cwd: '/home/ubuntu/votera/votera-server',
    script: 'yarn',
    args: 'start',
    env: {
      PUBSUB_ENABLE: 'true',
      BOSAGORA_CHAINID: {BOSAGORA_CHAINID},
      BOSAGORA_PROVIDER_URL: {BOSAGORA_PROVIDER_URL},
      BOSAGORA_QUERY_URL: {BOSAGORA_QUERY_URL},
      WALLET_VOTE_KEY: {WALLET_VOTE_KEY},
      COMMONS_BUDGET_ADDRESS: {COMMONS_BUDGET_ADDRESS},
      VOTERA_VOTE_ADDRESS: {VOTERA_VOTE_ADDRESS},
      HMAC_KEY: {HMAC_KEY},
      DATABASE_NAME: 'votera',
      DATABASE_USERNAME: {DATABASE_USERNAME},
      DATABASE_PASSWORD: {DATABASE_PASSWORD},
      PROPOSAL_INFO_HOST: {PROPOSAL_INFO_HOST},
    },
  }],
};

  11. start pm2

    cd ~
pm2 start ecosystem.config.js

  12. register system startup script

    cd ~
pm2 startup systemd

    copy/paste the generated command:

    sudo env PATH=$PATH:/home/centos/.nvm/versions/node/v14.20.1/bin /home/centos/.nvm/versions/node/v14.20.1/lib/node_modules/pm2/bin/pm2 startup systemd -u centos --hp /home/centos

  13. save the pm2 process list and enviornment

    pm2 save

nginx 설정은 다음과 같이 한다. 만약 이 nginx 가 외부에 direct 접근이 되는 서버라고 하면 443 으로 SSL 설정을 하고 만약 그렇지 않고 내부에서만 접근하는 서버라고 하면 8080 으로 해도 됨

S3 Configuration

Block public access (bucket settings) uncheck Block all public access

  • uncheck Block public access to buckets and objects granted through new access control lists (ACLs)
  • uncheck Blick public access to buckets and objects granted through any access control lists (ACLs)
  • check Block public access to buckets and objects granted through new public bucket or access point policies
  • check Block public and cross-account access to buckets and objects through any public bucket or access point policies

Edit Object Ownership

select ACLs enabled select Bucket owner preferred

Redis Configuration

sudo apt update
sudo apt upgrade
sudo apt install redis-server

Edit Redis configuration

sudo vi /etc/redis/redis.conf

edit following configuration

requirepass
bind
port
maxmemory
maxmemory-policy   allkeys-lru

Restart and register to auto start

sudo systemctl restart redis-server
sudo systemctl enable redis-server

About

Votera Server

Languages

Language:JavaScript 90.3%Language:HTML 9.7%