mirrors/LibreTranslate
1
1
Fork 1
mirror of https://github.com/LibreTranslate/LibreTranslate.git synced 2024-11-21 15:31:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Piero Toffanin 2023-07-04 09:42:58 +02:00 committed by GitHub
parent 05e66d4147
commit e2841ddc19
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 45 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
CONTRIBUTING.md
View file

@ -18,6 +18,51 @@ sudo apt-get install cmake
sudo dnf install cmake sudo dnf install cmake
``` ```
## Getting Started
```bash
git clone https://github.com/LibreTranslate/LibreTranslate.git
cd LibreTranslate
pip install -e .
libretranslate [args]
# Or
python main.py [args]
```
Then open a web browser to <http://localhost:5000>
## Run with Docker
Linux/macOS: `./run.sh [args]`
Windows: `run.bat [args]`
Then open a web browser to <http://localhost:5000>
## Build with Docker
```bash
docker build -f docker/Dockerfile [--build-arg with_models=true] -t libretranslate .
```
If you want to run the Docker image in a complete offline environment, you need to add the `--build-arg with_models=true` parameter. Then the language models are downloaded during the build process of the image. Otherwise, these models get downloaded on the first run of the image/container.
Run the built image:
```bash
docker run -it -p 5000:5000 libretranslate [args]
```
Or build and run using Docker Compose:
```bash
docker compose up -d --build
```
> Feel free to change the [`docker-compose.yml`](https://github.com/LibreTranslate/LibreTranslate/blob/main/docker-compose.yml) file to adapt it to your deployment needs, or use an extra `docker-compose.prod.yml` file for your deployment configuration.
>
> The models are stored inside the container under `/home/libretranslate/.local/share` and `/home/libretranslate/.local/cache`. Feel free to use volumes if you do not want to redownload the models when the container is destroyed. To update the models, use the `--update-models` argument.
## FAQ ## FAQ
### Externally Managed Environment ### Externally Managed Environment