diff --git a/docs/dev/used-techs/coolify.md b/docs/dev/used-techs/coolify.md new file mode 100644 index 0000000..1408dbe --- /dev/null +++ b/docs/dev/used-techs/coolify.md @@ -0,0 +1,12 @@ +--- +title: Coolify +parent: Used Techs +last_modified_date: 14.6.2025 +--- + +# Coolify + +## Ops Monitoring + +Enabling [Coolify notifications](https://coolify.io/docs/knowledge-base/notifications) are highly recommended. +There you can easily get updates around the clock. diff --git a/docs/dev/used-techs/docker.md b/docs/dev/used-techs/docker.md index 01aa71e..72d36c9 100644 --- a/docs/dev/used-techs/docker.md +++ b/docs/dev/used-techs/docker.md @@ -1,3 +1,11 @@ +--- +title: Docker +parent: Used Techs +last_modified_date: 14.6.2025 +--- + +# Docker + ## Useful Commands - List all the running dockers diff --git a/docs/dev/used-techs/index.md b/docs/dev/used-techs/index.md new file mode 100644 index 0000000..4a40b92 --- /dev/null +++ b/docs/dev/used-techs/index.md @@ -0,0 +1,9 @@ +--- +title: Used Techs +parent: Development Guide +last_modified_date: 14.6.2025 +--- + +# Used Techs + +Here you can find some general hints and info to use the techs we are leveraging in Linguly development. \ No newline at end of file diff --git a/docs/dev/used-techs/mongodb.md b/docs/dev/used-techs/mongodb.md new file mode 100644 index 0000000..bdb0d3e --- /dev/null +++ b/docs/dev/used-techs/mongodb.md @@ -0,0 +1,17 @@ +--- +title: MongoDB +parent: Used Techs +last_modified_date: 14.6.2025 +--- + +# MongoDB + +## Easy Modify/Monitor of live or local instances + +An easy way to connect to live or local MongoDB instances is to use [MongoDB Compass](https://www.mongodb.com/try/download/compass). +By just entering the connection URL you can view and edit all the entities. + +In order to connect to the live instances hosted using Coolify: +- We need to first make the DB publicly available. +- Then by using the public URL we can access the DB +- **Don't** forget to disable the public access when it is not required anymore \ No newline at end of file diff --git a/docs/home.md b/docs/home.md index ade483c..9abfd63 100644 --- a/docs/home.md +++ b/docs/home.md @@ -18,8 +18,20 @@ Linguly provides you the freedom to control how you are learning a new language --- ## Getting started -... to be defined +### Start Hosting Linguly + +To host and setup your Linguly instance you can follow the guides [here](https://docs.linguly.io/docs/setup/). + +### Start Development + +First of all thanks for your interest :) + +Secondly, to start, you need to set it up locally, which is not a big deal. Only if our documents are good enough for you. + +- Clone and follow [the local setup readme](https://github.com/Linguly/linguly-core?tab=readme-ov-file#local-setup) in Linguly Core +- To try the telegram interface try [this](https://github.com/Linguly/telegram-interface?tab=readme-ov-file#how-to-run-locally) +- And to update the documentations [here](https://github.com/Linguly/docs) ## What is Linguly? diff --git a/docs/setup/setup-ollama.md b/docs/setup/setup-ollama.md index 4e5d1eb..06c2a4a 100644 --- a/docs/setup/setup-ollama.md +++ b/docs/setup/setup-ollama.md @@ -1,11 +1,11 @@ --- -title: Setup Ollama for BasicModel +title: Setup Ollama Connection parent: Setup --- -# Setup Ollama for BasicModel +# Setup Ollama Connection -One of the easiest way to host an open source model and connect to Linguly is to host a model from Ollama library in Coolify. +One of the easiest way to host an open source model and connect to Linguly is to host a model from Ollama library in Coolify and connect to your Linguly Core via an Ollama Connection ## How to? @@ -16,8 +16,40 @@ One of the easiest way to host an open source model and connect to Linguly is to 1. Use the following command to download a desired model: `ollama pull llama3.2:3b` 1. To check the result you can use `ollama list` 1. If you want to run and test the model in terminal: `ollama run llama3.2:3b` - - -## For Local Tests +1. You can later remove the Open Webui by clicking on `Edit Compose File` and removing the section for Webui + +### 2. Connect to your Linguly Core + +In order to make a connection, we need to add the ollama service to the environment variables of our Linguly Core instance. + +1. Modify the Compose file in Ollama service to add it to the same docker network as your Linguly Core. + - For us its `coolify` network + - The final compose file should look like this: + + ``` + services: + ollama-api: + image: 'ollama/ollama:latest' + volumes: + - 'ollama:/root/.ollama' + networks: + - coolify + healthcheck: + test: + - CMD + - ollama + - list + interval: 5s + timeout: 30s + retries: 10 + + networks: + coolify: + external: true + ``` + +2. In your Linguly Core instance, go to `Environment Variables` and then set `OLLAMA_URL` to `http://ollama-api:11434` + +## For Local Tests You can install ollama locally from [here](https://ollama.com/download) and then `pull` a model similarly.