Skip to content

Latest commit

 

History

History
33 lines (30 loc) · 3.5 KB

README.md

File metadata and controls

33 lines (30 loc) · 3.5 KB

Access Governance System

How to run

  1. Install Docker
  2. Install Task
  3. Create a bot in Telegram and get a token
  4. Setup environment variables
    1. Copy .env.example to .env
    2. Edit .env file
  5. Run task up
Environment Variable Description Required
ENVIRONMENT Specifies the environment in which your application is running (development, production). Yes
VOTING_DURATION_DAYS The duration of voting events in your application, in days. Yes
INITIAL_SEEDERS A comma-separated list of telegram usernames who are initial seeders, likely having special roles or permissions. No
TELEGRAM_MEMBERS_CHAT_ID The ID of a chat in Telegram where members are present. Yes
DB_PASSWORD The password used to connect to your PostgreSQL database. Yes
DB_URL The connection string for your PostgreSQL database. Yes
TELEGRAM_ACCESS_GOVERNANCE_BOT_TOKEN The API token used to authenticate with the Telegram API for a bot that manages access to community. Yes
TELEGRAM_VOTE_BOT_TOKEN The API token used to authenticate with the Telegram API for a bot that manages voting. Yes
TELEGRAM_AUTHORIZATION_BOT_TOKEN The API token used to authenticate with the Telegram API for a bot that manages authorization to a community. Yes
DISCORD_AUTHORIZATION_BOT_TOKEN The API token used to authenticate with the Discord API for a bot that manages authorization to a community. Yes
DISCORD_SERVER_ID The ID of your server on Discord. Yes
DISCORD_GUEST_ROLE_ID The ID of the guest role on your Discord server. Yes
DISCORD_MEMBER_ROLE_ID The ID of the member role on your Discord server. Yes
VOTE_API_URL The URL of an API related to voting functionality. Yes
QUORUM The minimum proportion of members who must participate in a vote for it to be valid. Yes
MIN_YES_PERCENTAGE The minimum proportion of "yes" votes required for a vote to pass. Yes
YES_VOTES_TO_OVERCOME_NO The proportion of "yes" votes required to overcome any "no" votes and pass a vote. Yes

How to stop

Run task down