Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some setup documentation or setup thoughts. #30

Open
bdougie opened this issue May 7, 2021 · 4 comments
Open

Some setup documentation or setup thoughts. #30

bdougie opened this issue May 7, 2021 · 4 comments

Comments

@bdougie
Copy link

bdougie commented May 7, 2021

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.
@FiniteSingularity
Copy link
Member

Great thoughts! I will definitely look at making the setup docs more clear, keeping these things in mind.

@FiniteSingularity
Copy link
Member

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.

@FiniteSingularity
Copy link
Member

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.

@FiniteSingularity
Copy link
Member

@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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants