Files
OpenBB/website/content/bot/installation.md
jose-donato 6e9fefce9e Adds bot documentation to docusaurus and changes for hub (#4409)
* feat: adds bot docs to docu

* fix: file structure

* fix: brings changelog and switch platform button

* adding available options and changing Example text

* fix: detect whether iframe, fix availableoptions component, dynamic update third friday for options component

* fix: updated readme to reflect new changes

* fix: made it so from iframe only shows relevant sidebar

* PLAY BUTTON WOOO - works on discord/charting/chart

* comment

* fix: search bar, improve search

* fix: hijacks ctrl+k from iframe, adds visit to hub link

* about

* setting up play button for all images on Discord

* Bot docs updates

* terminal/faqs

* update main page

* add changelog to terminal

* SDK refactoring

* minor reordering

* bot struct in place

* move bot faqs over

* updating bot index and installation

* add new letterings

* fix: adds new navbar

* fix: new bot images and layouts

* updating installation and flow

* black linter

* spelling

* spelling

* The best commit

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-03-16 16:29:57 +00:00

2.6 KiB
Vendored
Raw Blame History

title, sidebar_position, description, keywords
title sidebar_position description keywords
Installation 1 How to get started with OpenBB Bot
installation
install
install openbb bot
guide
how to
explanation
openbb bot
openbb
discord
telegram

import AddBotDialog from "@site/src/components/General/AddBot";

Adding Bot to your Server

To add the bot to your server click on one of the links for your respective platform and then follow the instructions below.


Discord - First Time Setup

A pop-up window will open, asking you to log in to your Discord account and allow the bot access.

discord bot setup step 1

Once you log in, you’ll see a window asking for permission to access your account. Locate the “Add to Server” drop-down menu and click on it. discord bot setup step 2

This will open a list of Discord servers where you can add a bot. Select your server and press “Continue”.

Review permissions that the bot requests on your server. Select and deselect based on your needs, we recommend all the default settings in order to experience everything the bot has to offer. Click on “Authorize” when you’re ready. discord bot setup step 3

Congratulations! You’ve successfully added a bot to your Discord server.


Telegram - First Time Setup

After clicking on the Add to Telegram button it should open a chat with our OpenBB Bot.

telegram bot setup step 1

Go to your Telegram chat and click/tap on the Top Bar of the OpenBB Bot chat window.

telegram bot setup step 2

Then, you need to click on “More” and select "Add to Group or Channel" or just click "Add to Group or Channel" and select the Telegram group you want to add the chatbot to:

telegram bot setup step 3

Now you can verify it has the permissions required, we recommend the ones already selected, and you are ready to go!

telegram bot setup step 4