Introduction
DocsGPT is an open-source smart solution powered by AI that helps you retrieve relevant information from any technical documentation. This saves the time and effort of manual searches and makes it easier for users to get acquainted with the technical products or even use them.
In this tutorial, you will learn how to host a DocsGPT instance on the Kamatera Cloud Server.
Creating a Kamatera Cloud Server
Kamatera Cloud is one of the popular cloud providers that provides budget-friendly cloud solutions for enterprises of all levels.
To create a cloud server on Kamatera Cloud, follow the steps below.
Step 1: Sign up for a free account and get a 30-day free trial to test its solutions. If you're an existing user, simply login to your account.
Step 2: Once you're in the dashboard, click on My Cloud
and then click on Servers
.
Step 3: In the Server Management
dashboard, click on the Create New Server
button.
Step 4: You need to define the server configuration in the Create New Server
page. For this tutorial, feel free to use the configuration specified below.
- Choose Zone: Asia (China, Hong Kong) [Choose the closest zone to you.]
-
Choose An Image: Server OS Images
- Image: Ubuntu
- Choose Version: 22.04 64_bit_optimized_updated
-
Choose Server Specs: Use the specs given below.
- Type: B General
- CPU: 2
- RAM: 4GB
- SSD DISK#1: 30GB
- Daily Backup: Leave it unchecked.
- Management Services: Leave it unchecked.
-
Choose Networking: Simple Mode
- Public Internet Network: Keep it checked. (Sets a Public IP)
- Private Local Network: Keep it checked. (Sets a Private IP)
- Advanced Configuration: Hide
-
Finalize Settings: Use the settings given below.
- Password: Provide a password of your choice.
- Validate: Confirm the password once again.
- Server: 1
- Name: Provide a name of your choice for the server.
- Power On Servers: Keep it checked.
- Billing Cycle and Pricing: Hourly Billing Cycle
Now hit the Create Server
button to start booting up the server.
It will redirect you to the Server Management
dashboard where you can check the status of the server creation process by clicking on the Tasks Queue
tab at the left bottom section.
Step 5: Once the status is 100%, you can interact with the server by clicking on the ▶ button on the dashboard, then selecting the Connect
menu, and finally clicking on the Open Remote Console
button.
Deploying DocsGPT on the Server
You can use the DocsGPT source code to deploy it easily. Follow the steps given below to do so.
Step 1: Use the remote console to login to the server. The username will be root
and the password will be the one that you set above during server configuration.
Step 2: Now clone the DocsGPT GitHub repository to the server.
git clone https://github.com/arc53/DocsGPT.git
Step 3: You should update all the package information in the system before proceeding further. Use the command to do the update.
sudo apt update
Step 4: To run DocsGPT in the server, you need to install the container tools docker
and docker-compose
. You can use the command below to install them. Press Y+Enter
when prompted to proceed with the installation.
sudo apt install docker docker-compose
Step 5: Now navigate to the DocsGPT folder and add the necessary .env
variables.
cd DocsGPT/
nano .env
Set the following values in the .env
file.
API_KEY= <Your OpenAI API key>
VITE_API_STREAMING= true
Use Ctrl+X
, press Y
, and then hit Enter
to exit the Nano editor.
Step 6: You now need to set the correct IP address of the DocsGPT backend so that the front end can communicate with it. To do this, you need to change the following in the docker-compose.yaml
file of DocsGPT.
nano docker-compose.yaml
You can find the VITE_API_HOST
parameter on Line 7. Edit and save it so that it points to the public IP of this cloud server.
VITE_API_HOST=http://<Cloud Server Public IP>:7091
You can find the public IP of the server by going to the Network
tab on the Server Management
page.
Step 7: You can now use the command below to run your DocsGPT instance on the server.
sudo docker-compose up -d
The initial startup takes up some time, so wait until you get a done
status on the remote console terminal.
Testing the DocsGPT Instance
The DocsGPT instance is now available on the port 5173
. Use the public IP of the server to access its GUI.
http://<Cloud Server Public IP:5173>
You have to choose a source documentation when you open this URL. For now, select default
and click on Save
to proceed.
Feel free to ask generic questions to DocsGPT in the chat window and it will reply with the answers.
You: What is DocsGPT?
DocsGPT: DocsGPT is an AI-powered language model developed using OpenAI's GPT (Generative Pre-trained Transformer) architecture. It is designed specifically to assist users in composing and editing documents. DocsGPT can help generate text in various formats, such as essays, code snippets, technical documentation, and more. It understands natural language commands and provides informative responses to user queries. Through its conversational interface, DocsGPT can assist with a wide range of document-related tasks, including content generation, formatting, organization, and more.
Conclusion
In this tutorial, you learned about DocsGPT and Kamatera Cloud. You specifically created a Kamatera Cloud Server, deployed an instance of DocsGPT in it using docker
and docker-compose
, and finally tested DocsGPT with a sample question.
Now that you've deployed your instance of DocsGPT, feel free to try it out and test its various features. You can check out their official documentation here for further information.
Lastly, before you close this page, don't forget to drop a like and share your feedback in the comments below.
Top comments (0)