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

Bot API instance homepage #37

Open
cavallium opened this issue Dec 27, 2020 · 9 comments
Open

Bot API instance homepage #37

cavallium opened this issue Dec 27, 2020 · 9 comments
Labels
enhancement New feature or request

Comments

@cavallium
Copy link
Member

Add a very simple non-modifiable homepage on the bot api instance that shows the link of this repository, a small description on what is it, and a link to the future wiki on how to use/download it.
Something like this:

TDLight Telegram Bot API

This is a customized instance of telegram bot apis.

To use it, take a look on our documentation: http://link-of-the-documentation

To host an instance, download the server from our repository: https://github.com/tdlight-team/tdlight-telegram-bot-api

@cavallium cavallium added the enhancement New feature or request label Dec 27, 2020
@cavallium
Copy link
Member Author

This can help the users that don't know how to find the documentation, instead of showing them the same 404 json string that appears on the other addresses.

@MarcoBuster
Copy link
Collaborator

That would be great. 👍

@spontanurlaub
Copy link
Collaborator

Or maybe the possibility to set a redirect via command line parameter? We could set the redirect on our publicly hosted instances without interfering with the default behaviour

@cavallium
Copy link
Member Author

Or maybe the possibility to set a redirect via command line parameter? We could set the redirect on our publicly hosted instances without interfering with the default behaviour

Yes but the default behavior is not useful in any way, since every call to the bot api is made always on a subdirectory.
We could do both: add a default page, and a redirect if someone changes it via the command line parameter.

@spontanurlaub
Copy link
Collaborator

@cavallium Having a hosted webpage and a redirect doesn't make much sense. If someone wants to redirect he could simply use a html redirect, has the same effect

@cavallium
Copy link
Member Author

You are right

@spontanurlaub
Copy link
Collaborator

@cavallium I don't like the idea of hosting a homepage on the bot api. We would need to pack all css and other static content like images into one big html file that we would serve, adding load and memory consumption without providing much benefit over a redirect, I think a redirect to a properly hosted homepage is better.

@luckydonald
Copy link
Collaborator

That's what I envisioned the API docs to be served at.

@luckydonald
Copy link
Collaborator

I vote to close this as not in scope of the Bot API.
Instead any reverse proxy is probably better for that task.

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

4 participants