+
+
+
+
-## Features
+## Get started
-* Collect and manage feedback
-* Create custom boards and statuses, to better organize feedback
-* Customize your roadmap, to let your users know what you're working on
-* Many more...
+### Hosted
-## Requirements
+We offer a hosted solution, so you don't have to provision your own server. This is the easiest and fastest way to get started: you can sign up and start collecting feedback in a few minutes.
-* Docker
-* Docker Compose
+[Start your 7-day free trial](https://login.astuto.io/signup) without entering any payment method, then it's 15 €/month with annual subscription or 20 €/month with monthly subscription. [Learn more on astuto.io](https://astuto.io/?utm_campaign=github_getstarted&utm_source=github.com).
-You can install [Docker Desktop](https://docs.docker.com/desktop/) which includes everything you need to run Astuto. If you are on Linux, you may instead install Docker Engine, Docker CLI and then install the [Docker Compose Plugin](https://docs.docker.com/compose/install/).
+With the paid plan:
-## Installation
+- You avoid deployment hassles like renting a server, issuing SSL certificates, configuring a mail server and managing updates
+- You get some OAuth providers out of the box: Google, Facebook and GitHub are ready to log your users in, no configuration needed
+- You get priority support
+- You support open source and get our eternal gratitude :)
-### DockerHub image (fastest, for production)
+### Self-hosted
+0. Ensure you have Docker and Docker Compose installed
1. Create an empty folder
2. Inside that folder, create a `docker-compose.yml` file with the following content:
```
@@ -62,31 +64,29 @@ services:
volumes:
dbdata:
```
-3. Edit the environment variables to fit your needs
+3. Edit the environment variables to fit your needs. You can find more information about env variables in the [documentation](https://docs.astuto.io/deploy-docker#2-edit-the-environment-variables-in-the-docker-compose-file).
4. Run `docker compose pull`
5. Run `docker compose up`
6. You should now have a running instance of Astuto on port 3000. A default user account has been created with credentials email: `admin@example.com`, password: `password`.
**Note**: if you are on Linux and you encounter permission denied errors when running Docker commands, try to run them as administrator.
-### GitHub repository (for development)
+## Documentation
-**Note**: this installation method is suggested for developers and contributors. If you just want to deploy your Astuto instance or try it out, we recommend to follow the above DockerHub installation instructions.
-
-See [contributing guidelines](https://github.com/riggraz/astuto/blob/main/CONTRIBUTING.md).
+Check out [docs.astuto.io](https://docs.astuto.io/) to learn how to deploy Astuto, configure custom OAuth providers, customize appearance and more!
## Contributing
-You are welcome to contribute:
-* Read our [contributing guidelines](https://github.com/riggraz/astuto/blob/main/CONTRIBUTING.md)
-* Join the [Discord channel](https://discord.gg/SrtUMRp) to get in touch
+There are many ways to contribute to Astuto, not just coding. Proposing features, reporting issues, translating to a new language or improving documentation are a few examples! Please read our [contributing guidelines](https://github.com/riggraz/astuto/blob/main/CONTRIBUTING.md) to learn more.
## Credits
-Astuto logo created by [Freepik Flaticon](https://www.flaticon.com/free-icons/fox).
+Astuto logo and all image assets are credited [here](https://astuto.io/credits).
-A huge thank you to all people who contributed:
+A huge thank you to code contributors