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

Enhancement - Document .env configuration and pre-requisite installs #564

Closed
developersteve opened this issue Jul 10, 2024 · 4 comments · Fixed by #565
Closed

Enhancement - Document .env configuration and pre-requisite installs #564

developersteve opened this issue Jul 10, 2024 · 4 comments · Fixed by #565
Labels
Status: Needs Review This issue/PR needs an initial or additional review Type: Bug Involves something that isn't working as intended

Comments

@developersteve
Copy link

Complete the following REQUIRED checkboxes:

  • [ x] I have thoroughly read and understand The Odin Project Contributing Guide

  • [ x ] The title of this issue follows the Bug - location of bug: brief description of bug format, e.g. Bug - points command: Extra whitespace causes command to not be called

Some steps are missing from the getting started documentation when deploying bot including the requirement to install redis, and possibly other pre-requisite installations for a successful odin-bot-v2 deployment. Without these installations, it will cause errors to occur related to the REDIS_URL=redis://localhost:6379 line within the env config.

Additionally, it looks like there are some missing configurational .env elements, including some admin-related features as outlined in the config.js file

@developersteve developersteve added Status: Needs Review This issue/PR needs an initial or additional review Type: Bug Involves something that isn't working as intended labels Jul 10, 2024
@developersteve
Copy link
Author

developersteve commented Jul 10, 2024

Additionally Ive just discovered the https://www.theodinproject.com/api/points api call using the undocumented .env var for the pointsbot_token.

Is there any particular format for the schema on that API so it can be replicated elsewhere, ideally locally?

This token not being set actually causes a crash to happen if there's no token set, this may need some type of case break set to ensure that a message is returned telling the user that they need to have the token configured.

@MaoShizhong
Copy link
Contributor

Thanks for catching that, @developersteve. I've added the redis installation pre-req to the wiki, which should be the only missing pre-req to actually get the bot up and running locally.

@01zulfi do you know more about the points bot mentioned above? And do we also actually need the #getting-hired channel ID as an env variable and not hardcoded into config.js like with the other channel IDs? Since that seems to be the only time it's used.

@01zulfi
Copy link
Member

01zulfi commented Jul 10, 2024

@MaoShizhong thanks for adding Redis on wiki.

Points bot token is required for the bot to successfully create points on the site's db. afaik there's only a production token available. Let me ask the team if there's a dev version of the token available.

And as far as the getting hired channel id, I agree it shouldn't be a env var. Let me fix this.

@MaoShizhong
Copy link
Contributor

The bot dev token issue is superseded by #581 and the other issues have been addressed - will close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Needs Review This issue/PR needs an initial or additional review Type: Bug Involves something that isn't working as intended
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants