Skip to content

Latest commit

 

History

History
 
 

platform

README.md

Platform

To start your Phoenix server:

  • Install dependencies with mix deps.get
  • Create and migrate your database with mix ecto.setup
  • Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server

Now you can visit localhost:4000 from your browser.

Ready to run in production? Please check our deployment guides.

Environment Variables

  • S3_BUCKET — the primary S3 bucket to use for content
  • AWS_REGION — the AWS region for S3
  • AWS_MAILER_REGION — the AWS region for mail
  • AWS_ACCESS_KEY_ID — the AWS access key id
  • AWS_SECRET_ACCESS_KEY — the AWS access secret
  • APPSIGNAL_PUSH_KEY — the AppSignal push key
  • APPSIGNAL_APP_ENV — dev, staging, or prod (how we disambiguate environments in AppSignal)
  • SLACK_AUDITING_WEBHOOK — Slack webhook for audit events
  • HCAPTCHA_SITE_KEY — hCaptcha site key
  • HCAPTCHA_SECRET — hCaptcha secret
  • ENABLE_CAPTCHAS — captchas are checked if true (default false for development)
  • WATERMARK_FONT_PATH — path to the font to use in watermarks
  • INSTANCE_NAME — user-facing instance name (appears in footer and below logo; not shown if empty)
  • SPN_ARCHIVE_API_KEY — API key for the Internet Archive SPN API (if provided, Atlos will submit all links to the Internet Archive for persistent archival; key expected in the form myaccesskey:mysecret)
  • COMMUNITY_DISCORD_LINK — link to the community Discord server (shown in onboarding and in Settings)
  • ATTRIBUTE_OPTIONS — JSON object of attribute options; e.g., {"type": ["Civilian Harm"], "impact": ["Structure", "Structure/Residential"], "equipment": ["Small Arm", "Munition"]}
  • AUTOTAG_USER_INCIDENTS — JSON object of tags to apply to incidents created by non-privileged users; e.g., ["Volunteer"]
  • DEVELOPMENT_MODE — whether to run Atlos in development mode (e.g., TESTING becomes a valid invite code)
  • HIGHLIGHT_CODE — Code for Highlight analytics and monitoring
  • RESTRICT_PROJECT_CREATION — whether to restrict project creation to privileged users only (to enable, set to true)
  • ONBOARDING_PROJECT_ID — the ID of the demo onboarding project template; if unset, the onboarding project will not be created.

Learn more