{"id":25899094,"url":"https://github.com/varnamproject/varnamd-govarnam","last_synced_at":"2025-10-19T22:09:29.975Z","repository":{"id":44712077,"uuid":"407801541","full_name":"varnamproject/varnamd-govarnam","owner":"varnamproject","description":"API server for Varnam","archived":false,"fork":false,"pushed_at":"2024-12-31T21:50:04.000Z","size":306,"stargazers_count":20,"open_issues_count":4,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-31T22:25:26.233Z","etag":null,"topics":["go","golang","indian"],"latest_commit_sha":null,"homepage":"https://api.varnamproject.com/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/varnamproject.png","metadata":{"files":{"readme":"README-docker.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-18T08:24:26.000Z","updated_at":"2024-12-31T21:50:08.000Z","dependencies_parsed_at":"2023-11-06T13:45:00.278Z","dependency_job_id":"c96ec38a-8cc3-4fbc-b109-1175ca5f61d4","html_url":"https://github.com/varnamproject/varnamd-govarnam","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varnamproject%2Fvarnamd-govarnam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varnamproject%2Fvarnamd-govarnam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varnamproject%2Fvarnamd-govarnam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varnamproject%2Fvarnamd-govarnam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/varnamproject","download_url":"https://codeload.github.com/varnamproject/varnamd-govarnam/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241593901,"owners_count":19987664,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["go","golang","indian"],"created_at":"2025-03-03T01:27:24.150Z","updated_at":"2025-10-19T22:09:24.929Z","avatar_url":"https://github.com/varnamproject.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker setup\n\nThis repo contains the Docker setup for building a single debian-slim container with the `libgovarnam.so` shared lib, `varnamcli`, `varnamd-govarnam` (HTTP server) compiled with glibc.\n\n### Running the remote image\n\nA pre-compiled Docker image is available on the GitHub registry. This is the simplest way to run the server (`port 8123` by default).\n\nDownload [config.toml](https://raw.githubusercontent.com/varnamproject/varnamd-govarnam/master/config.toml) and edit it.\n\nRun:\n\n```bash\ndocker run -e VARNAM_LEARNINGS_DIR=/varnamd/learnings -e VARNAM_VST_DIR=/varnamd/vst \\\n\t-v $(pwd)/config.toml:/varnamd/config.toml \\\n\t-v $(pwd)/data/learnings/:/varnamd/learnings/ \\\n\t-v $(pwd)/data/vst/:/varnamd/vst/ \\\n\t-v $(pwd)/data/input/:/varnamd/input/ \\\n\t-p 8123:8123 \\\n\t--name varnamd ghcr.io/varnamproject/varnamd:latest\n```\n\nPS: Add the `-d` flag to `docker run` to run the server in the background.\n\n### Building the image locally\n\n- Download the [Dockerfile](https://github.com/varnamproject/varnamd-govarnam/blob/master/Dockerfile)\n- Run `docker build -t varnamd .` to build an image named `varnamd` locally.\n\n### Running the local image\n\nDownload [config.toml](https://raw.githubusercontent.com/varnamproject/varnamd-govarnam/master/config.toml) and edit it.\n\n```bash\ndocker run -e VARNAM_LEARNINGS_DIR=/varnamd/learnings -e VARNAM_VST_DIR=/varnamd/vst \\\n\t-v $(pwd)/config.toml:/varnamd/config.toml \\\n\t-v $(pwd)/data/learnings/:/varnamd/learnings/ \\\n\t-v $(pwd)/data/vst/:/varnamd/vst/ \\\n\t-v $(pwd)/data/input/:/varnamd/input/ \\\n\t-p 8123:8123 \\\n\t--name varnamd varnamd\n```\n\n## Importing words\n\n[Read this doc](https://varnamproject.com/docs/learning/) to learn more on teaching words to Varnam.\n\nThe image comes with `varnamcli` that can be used for training. Varnam dictionary is stored in the host mounted `./data/learnings` directory.\n\n- Run the `varnamd` container.\n- Ensure that the necessary scheme (`-s` flag) [VST file](https://github.com/varnamproject/schemes/releases) is present in the local `./data/vst` directory.\n- Copy the files needed for learning to `./data/input`, eg: `./data/input/yourfile.txt`\n\nThen run:\n\n```bash\ndocker exec varnamd varnamcli -s ml -learn-from-file /govarnam/input/yourfile.txt\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarnamproject%2Fvarnamd-govarnam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvarnamproject%2Fvarnamd-govarnam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarnamproject%2Fvarnamd-govarnam/lists"}