Evidence Cloud
Evidence Cloud is the easiest way to host Evidence apps. It's maintained by the Evidence team, and allows you to securely host Evidence apps without having to worry about maintaining your own infrastructure.
- Easy to set up: Deploy in 5 minutes without configuring any infrastructure.
- Secure: Manage access for users in your team.
- Organizational domain: Host your app at
[organisation].evidence.app
. - Scheduled refreshes: Daily (or more frequent) data updates to your app.
- Re-build on push: Merge to your target branch to rebuild your app.
- Custom domains: Add a custom domain to your app.
- Cloud execution engine: Offload heavy queries to our Cloud SQL engine for faster performance.
Prerequisites
- A GitHub account
- An Evidence project pushed to GitHub (optional)
Deploy Evidence to Evidence Cloud
- Go to Evidence Cloud and login with GitHub
- Choose an option to get started:
- If you have an existing Evidence project: click
Add Project
- If you don't have a Evidence project yet: select
Start from our templates
, and choose evidence-dev/template.
- If you have an existing Evidence project: click
- Deploy your project
- Repository: Choose the GitHub repository containing your Evidence project
- Branch: Edit if required
- Domain: Choose the subdomain you want to deploy to
- (Optional) Root directory: Edit to point to your Evidence directory if you are using a monorepo
- Authentication: None, Email and Password (Paid plans only), or SSO (Paid plans only)
- Set your environment variables
- If you are deploying an existing project, click "Paste Environment Variables"
- Navigate to the settings page and use the Copy All button to copy them to your clipboard, then paste them into the Environment Variables section. Click Save.
- Alternatively, you can find credentials in
connection.options.yaml
files in your/sources/your_source
directory, and enter them in KEY=VALUE format on separate lines. - The key format used should be
EVIDENCE_SOURCE__[your_source]__[option_name]
(Note the casing matches your source names, and the double underscores). Note that the values are base64 encoded, and will need to be decoded.
- If you are deploying from a template, click "Use Template Environment Variables"
- If you are deploying an existing project, click "Paste Environment Variables"
- Click
Deploy your project
Your app will be deployed to https://[your-subdomain].evidence.app
Domains, Authentication and Scheduling
Authentication
Evidence Cloud Team and Enterprise plans support private apps with auth. If you need to configure an SSO provider, reach out to our team on Slack.
Custom Domains
Evidence Cloud Enterprise plans support custom domains. Reach out to our team on Slack to set your domain up.
Data Refresh
To adjust your deployment schedule, select your app in Evidence Cloud, click Schedule, and adjust the schedule.
Community Plan sites can be refreshed daily. More frequent refreshes are available on the Team and Enterprise plans.