Some setup documentation or setup thoughts.
After forking the repository what is next?
something I found could use extra documentation are
- setting secrets up in general
- tau-db context is needed
- needs a webhook secret that is longer than 10 char and less than 100.
Great thoughts! I will definitely look at making the setup docs more clear, keeping these things in mind.
A quick update- there are some pretty significant changes currently being made to the docker/compose setup. These changes should not be breaking for existing installations, but they would greatly simplify and streamline the setup/install process.
I just merged in PR #39 , to which I added a heavily commented/documented .env_sample file, and greatly reduced the number of environment variables that need to be set to get up and running. I still need to update the README.me file documentation to reflect this, but i think it is a big step in the right direction.
@bdougie - We have added some more detailed (and hopefully easier to follow) documentation for setting up a local instance of TAU. You can see the docs here: https://github.com/Team-TAU/tau/blob/main/docs/deployment/local.md . We are also working on having this documentation auto-generated on a readthedocs site. Please let me know what you think, and feel free to discuss here, or make some PRs if you have some ideas on how to improve things further!