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

Readme improvements #34

Open
guisua opened this issue May 31, 2020 · 2 comments
Open

Readme improvements #34

guisua opened this issue May 31, 2020 · 2 comments
Labels
enhancement New feature or request

Comments

@guisua
Copy link

guisua commented May 31, 2020

Just as a bit of feedback, maybe it would be nice to update the README to include the following:

  • explain whether local IPs work for the OMBI_HOST
    -if not, make it clear that a public IP is needed
  • clearly indicate whether http or https should/can/must be used
  • in addition to the bot.env sample code, add a mocked but real bot.env sample
    • it wasn't immediately clear to me whether to use include <> or "" for the values
@guisua
Copy link
Author

guisua commented May 31, 2020

Maybe something like this?

|Parameter||Description|
|:--|:-:|:--|
|`OMBI_HOST`||Public IP address of your Ombi instance. Only `http://` is supported|
|`OMBI_KEY`||Go to your Ombi > Settings > Ombi (1st tab) > Api Key|
|`OMBI_BOT_TOKEN`||The BotFather gave you this token when creating your Telegram Bot|
|`OMBI_BOT_NAME`||The unique Telegram name you gave your bot when creating it using BotFather|
|`OMBI_USER_NAME`|OPTIONAL|Ombi admin username
|`BOT_ADMIN`|OPTIONAL|The admin's Telegram user id|
|`BOT_CHAT_ID`|OPTIONAL|The allowed Telegram chat's id|

At the end, your `bot.env` file should look something like this:

//```
OMBI_HOST=http://mydomain.com:12345
OMBI_KEY=abcdefghijklmnopqrstuvwxyz1234567890
OMBI_BOT_TOKEN=1234567890:abcdefghijklmnopqrstuvwxyz1234567890
OMBI_BOT_NAME=cool_bot_for_ombi
OMBI_USER_NAME=mike_sampleman
BOT_ADMIN=1234567890
BOT_CHAT_ID=1234567890
//```

@StackTraceYo
Copy link
Owner

sure - make a pull request

@StackTraceYo StackTraceYo added the enhancement New feature or request label Jul 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants