From 76c3b2d5035fc9f27877b61ed7b87311f6cf9166 Mon Sep 17 00:00:00 2001 From: neo2100 Date: Thu, 5 Jun 2025 15:10:53 +0200 Subject: [PATCH 1/2] Setup Mpngp and Redis in Coolify --- docs/dev/used-techs/mongodb.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/dev/used-techs/mongodb.md diff --git a/docs/dev/used-techs/mongodb.md b/docs/dev/used-techs/mongodb.md new file mode 100644 index 0000000..71343db --- /dev/null +++ b/docs/dev/used-techs/mongodb.md @@ -0,0 +1,18 @@ +--- +title: Mongodb for development +parent: Development Guide +nav_order: 1 +last_modified_date: 31.5.2025 +--- +# Mongodb for development + +For most of our functionalities we are using Mongodb primarily. +To have an easy local setup similar to the deployed version, we recommend to use the free tier of [MongoDB Atlas](https://www.mongodb.com/atlas). +There you can simply create an account [here](https://www.mongodb.com/atlas) and select the free tier. +Then create a connection url and update the `.env` file based on the Database instance you want to configure. +Create the DBs and collections as you need. + + +TODO: + - add link to .env and more info about it + - add link to the Database Instance information \ No newline at end of file From 876be9988be95863fa57a6b2d04fbb623345e49a Mon Sep 17 00:00:00 2001 From: neo2100 Date: Thu, 5 Jun 2025 17:34:42 +0200 Subject: [PATCH 2/2] Setup Mongo and Redis in Coolify --- docs/dev/troubleshoot/docs.md | 3 +++ docs/dev/used-techs/mongodb.md | 18 ------------------ docs/setup/linguly-core-in-coolify.md | 2 +- docs/setup/mongodb.md | 23 +++++++++++++++++++++++ docs/setup/redis.md | 18 ++++++++++++++++++ 5 files changed, 45 insertions(+), 19 deletions(-) delete mode 100644 docs/dev/used-techs/mongodb.md create mode 100644 docs/setup/mongodb.md create mode 100644 docs/setup/redis.md diff --git a/docs/dev/troubleshoot/docs.md b/docs/dev/troubleshoot/docs.md index 124770f..2b618de 100644 --- a/docs/dev/troubleshoot/docs.md +++ b/docs/dev/troubleshoot/docs.md @@ -12,3 +12,6 @@ last_modified_date: 1.6.2025 Images may not be shown although you see them in a preview. It is likely because the paths are slightly different in the generated files and you might need to go one level back to the parent folder. e.g. [check here](https://github.com/Linguly/docs/blob/main/docs/setup/how-to-setup.md?plain=1#L40) +### Cross reference path is not working in the final doc +Similar to images, any other path need an extra move to the parent directory (`../`). + diff --git a/docs/dev/used-techs/mongodb.md b/docs/dev/used-techs/mongodb.md deleted file mode 100644 index 71343db..0000000 --- a/docs/dev/used-techs/mongodb.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Mongodb for development -parent: Development Guide -nav_order: 1 -last_modified_date: 31.5.2025 ---- -# Mongodb for development - -For most of our functionalities we are using Mongodb primarily. -To have an easy local setup similar to the deployed version, we recommend to use the free tier of [MongoDB Atlas](https://www.mongodb.com/atlas). -There you can simply create an account [here](https://www.mongodb.com/atlas) and select the free tier. -Then create a connection url and update the `.env` file based on the Database instance you want to configure. -Create the DBs and collections as you need. - - -TODO: - - add link to .env and more info about it - - add link to the Database Instance information \ No newline at end of file diff --git a/docs/setup/linguly-core-in-coolify.md b/docs/setup/linguly-core-in-coolify.md index 53781d2..b71ab9f 100644 --- a/docs/setup/linguly-core-in-coolify.md +++ b/docs/setup/linguly-core-in-coolify.md @@ -9,7 +9,7 @@ nav_order: 2 ## Docker Network - Setup it in same network as other services - Setup in `coolify` default network otherwise need to modify network in the docker-compose.yaml -- More info in [this ADR](../dev/adr/network-connectivity-of-services.md) +- More info in [this ADR](../../dev/adr/network-connectivity-of-services) ## Environment Variables Add the environment variables based on the [readme](https://github.com/Linguly/linguly-core?tab=readme-ov-file#environment-variables-for-local-setup). diff --git a/docs/setup/mongodb.md b/docs/setup/mongodb.md new file mode 100644 index 0000000..8b3d6a6 --- /dev/null +++ b/docs/setup/mongodb.md @@ -0,0 +1,23 @@ +--- +title: Mongodb for development or self-host +parent: Development Guide +nav_order: 3 +last_modified_date: 5.6.2025 +--- +# Mongodb for development or self-host + +For most of our functionalities we are using Mongodb primarily. +To have an easy local setup similar to the deployed version, we recommend to use the free tier of [MongoDB Atlas](https://www.mongodb.com/atlas). +There you can simply create an account [here](https://www.mongodb.com/atlas) and select the free tier. +Then create a connection url and update the `.env` file based on the Database instance you want to configure ([e.g. here in Linguly Core](https://github.com/Linguly/linguly-core?tab=readme-ov-file#environment-variables-for-local-setup)). +Create the DBs and collections as you need. + + +## Setup in Coolify + +Mongodb setup in Coolify is straight forward: + +- Create a new resource +- Select Mongodb and then Coolify will create a URL which include username and password +- Start the DB +- Copy the URL and paste it the mongodb url environment variable of the services you want e.g. [Linguly Core](https://github.com/Linguly/linguly-core) diff --git a/docs/setup/redis.md b/docs/setup/redis.md new file mode 100644 index 0000000..46d0a0a --- /dev/null +++ b/docs/setup/redis.md @@ -0,0 +1,18 @@ +--- +title: Redis for development or self-host +parent: Development Guide +nav_order: 4 +last_modified_date: 5.6.2025 +--- +# Redis for development or self-host + +For most of our in memory DB usages we are using Redis primarily. +To have an easy local setup just install it locally and make sure it is running when you are running any service depending on it e.g. [Telegram Interface](https://github.com/Linguly/telegram-interface). + +## Setup in Coolify + +Redis setup in Coolify is straight forward: +- Create a new resource +- Select Redis and then Coolify will create a URL and a password +- Start the DB +- Copy the URL and Password, and paste them to the respective environment variables of the services you want e.g. [Telegram Interface](https://github.com/Linguly/telegram-interface).