StanGirard/quivr
1
1
Fork 0
mirror of https://github.com/StanGirard/quivr.git synced 2024-11-27 18:32:55 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update vps_install.md for subdomain (#1589)

Browse Source 
Changes so it reflects subdomain configuration

# Description

I've added subdomain configuration as many people use their domains
instead of creating a new domain root as the main one.
This commit is contained in:
jbeltran73-2 2023-11-06 09:53:12 +01:00 committed by GitHub
parent ab11b384f7
commit dde5f2335e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docs/Developers/vps_install.md
View File

@ -13,6 +13,7 @@ Welcome to the installation guide for Quivr, your go-to open-source project . Th
- [Step-by-Step Installation](#step-by-step-installation)
- [Step 1: Clone Quivr Repository](#step-1-clone-quivr-repository)
- [Step 2: Create `.env` File](#step-2-create-env-file)
- [Step 3: Configure `.env` Files for Backend and Frontend](#step-3-configure-env-files-for-backend-and-frontend)
- [Step 4: Launch Quivr with Docker Compose](#step-4-launch-quivr-with-docker-compose)
- [Step 5: Verify Installation](#step-5-verify-installation)
@ -28,7 +29,7 @@ Before diving into the installation process, please ensure you have the followin
- `api.<yourdomain>`
- `<yourdomain>`
> Replace `<yourdomain>` with your actual domain name throughout this guide.
> Replace `<yourdomain>` with your actual domain name throughout this guide. This domain also could be a subdomain like bot.<yourdomain>.com. In this case in your DNS configuration make sure that bot.<yourdomain.com> is also pointing to the IP address of your server, like you did with "flower.api" and "api".
## Step-by-Step Installation
@ -54,6 +55,7 @@ EMAIL=your-email@example.com
DOMAIN_NAME=yourdomain.com
API_DOMAIN_NAME=api.yourdomain.com
```
note: in this file if you used a subdomain, DOMAIN_NAME would be bot.<yourdomain.com> and API_DOMAIN_NAME would be api.<yourdomain.com>
Don't forget to save your changes (`Ctrl+X`, then `Y`, and `Enter`).
@ -72,7 +74,7 @@ The `docker-compose.local.yml` file includes **Traefik**, which automagically ha
### Step 5: Verify Installation
Once everything is up and running, give yourself a pat on the back and verify that the services are accessible:
- Visit `https://yourdomain.com`
- Visit `https://yourdomain.com` or `https://bot.yourdomain.com`
- And `https://api.yourdomain.com`
You should be greeted by your new Quivr setup, all shiny and secure!
@ -84,4 +86,4 @@ You should be greeted by your new Quivr setup, all shiny and secure!
> Always use HTTPS for production environments to ensure the security of your data and communications.
**Congratulations!** Your Quivr server should now be successfully installed and secured with HTTPS. Happy project managing!
**Congratulations!** Your Quivr server should now be successfully installed and secured with HTTPS. Happy project managing!