LLM/DocsGPT
1
0
Fork 0
mirror of https://github.com/arc53/DocsGPT.git synced 2025-12-03 18:43:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update doc formatting and fix some spelling.

Browse Source
This commit is contained in:
Roman Zhukov
2023-10-05 20:27:48 +03:00
parent d13e5e7e3f
commit d37885ea88
8 changed files with 68 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/pages/Deploying/Hosting-the-app.md
View File

@@ -4,7 +4,7 @@ Here's a step-by-step guide on how to setup an Amazon Lightsail instance to host
## Configuring your instance
(If you know how to create a Lightsail instance, you can skip to the recommended configuration part by clicking here)
(If you know how to create a Lightsail instance, you can skip to the recommended configuration part by clicking here).
### 1. Create an account or login to https://lightsail.aws.amazon.com
@@ -36,7 +36,7 @@ Your instance will be ready for use a few minutes after being created. To access
#### Clone the repository
A terminal window will pop up, and the first step will be to clone the DocsGPT git repository.
A terminal window will pop up, and the first step will be to clone the DocsGPT git repository:
`git clone https://github.com/arc53/DocsGPT.git`
@@ -64,11 +64,11 @@ Enter the following command to access the folder in which DocsGPT docker-compose
#### Prepare the environment
Inside the DocsGPT folder create a .env file and copy the contents of .env_sample into it.
Inside the DocsGPT folder create a `.env` file and copy the contents of `.env_sample` into it.
`nano .env`
Make sure your .env file looks like this:
Make sure your `.env` file looks like this:
```
OPENAI_API_KEY=(Your OpenAI API key)
@@ -103,10 +103,10 @@ Before you are able to access your live instance, you must first enable the port
Open your Lightsail instance and head to "Networking".
Then click on "Add rule" under "IPv4 Firewall", enter 5173 as your port, and hit "Create".
Repeat the process for port 7091.
Then click on "Add rule" under "IPv4 Firewall", enter `5173` as your port, and hit "Create".
Repeat the process for port `7091`.
#### Access your instance
Your instance will now be available under your Public IP Address and port 5173. Enjoy!
Your instance will now be available under your Public IP Address and port `5173`. Enjoy!

26
docs/pages/Deploying/Quickstart.md
View File

@@ -9,23 +9,23 @@ It will install all the dependencies and give you an option to download the loca
Otherwise, refer to this Guide:
1. Open and download this repository with `git clone https://github.com/arc53/DocsGPT.git`
2. Create a .env file in your root directory and set your `API_KEY` with your openai api key
3. Run `docker-compose build && docker-compose up`
4. Navigate to `http://localhost:5173/`
1. Open and download this repository with `git clone https://github.com/arc53/DocsGPT.git`.
2. Create a `.env` file in your root directory and set your `API_KEY` with your openai api key.
3. Run `docker-compose build && docker-compose up`.
4. Navigate to `http://localhost:5173/`.
To stop just run Ctrl + C
To stop just run `Ctrl + C`.
### Chrome Extension
To install the Chrome extension:
1. In the DocsGPT GitHub repository, click on the "Code" button and select Download ZIP
2. Unzip the downloaded file to a location you can easily access
3. Open the Google Chrome browser and click on the three dots menu (upper right corner)
4. Select "More Tools" and then "Extensions"
5. Turn on the "Developer mode" switch in the top right corner of the Extensions page
6. Click on the "Load unpacked" button
7. Select the "Chrome" folder where the DocsGPT files have been unzipped (docsgpt-main > extensions > chrome)
8. The extension should now be added to Google Chrome and can be managed on the Extensions page
1. In the DocsGPT GitHub repository, click on the "Code" button and select "Download ZIP".
2. Unzip the downloaded file to a location you can easily access.
3. Open the Google Chrome browser and click on the three dots menu (upper right corner).
4. Select "More Tools" and then "Extensions".
5. Turn on the "Developer mode" switch in the top right corner of the Extensions page.
6. Click on the "Load unpacked" button.
7. Select the "Chrome" folder where the DocsGPT files have been unzipped (docsgpt-main > extensions > chrome).
8. The extension should now be added to Google Chrome and can be managed on the Extensions page.
9. To disable or remove the extension, simply turn off the toggle switch on the extension card or click the "Remove" button.