LibreTranslate/README.md

51 lines
1.8 KiB
Markdown
Raw Normal View History

2020-12-19 19:19:35 +00:00
# LibreTranslate
2020-12-20 20:52:02 +00:00
Free and Open Source Translation API.
2020-12-20 21:04:48 +00:00
Entirely self-hosted and can work in offline environments. Unlike other APIs, it doesn't rely on proprietary providers such as Google or Azure to perform translations.
2020-12-20 20:52:02 +00:00
![image](https://user-images.githubusercontent.com/1951843/102724116-32a6df00-42db-11eb-8cc0-129ab39cdfb5.png)
2020-12-20 21:04:48 +00:00
[Try it online!](https://libretranslate.com) | [API Docs](https://libretranslate.com/docs)
2020-12-20 20:52:02 +00:00
2020-12-20 21:04:48 +00:00
Website: [libretranslate.com](https://libretranslate.com)
2020-12-20 20:52:02 +00:00
## Build and Run
Make sure you have installed Python (3.8 or higher), then simply issue:
```bash
git clone https://github.com/uav4geo/LibreTranslate --recurse-submodules
cd LibreTranslate
pip install -r requirements.txt
python main.py [args]
```
## Arguments
| Argument | Description | Default |
| ------------- | ------------------------------ | -------------------- |
| --host | Set host to bind the server to | `127.0.0.1` |
| --port | Set port to bind the server to | `5000` |
| --char-limit | Set character limit | `No limit` |
| --req-limit | Set maximum number of requests per minute per client | `No limit` |
| --ga-id | Enable Google Analytics on the API client page by providing an ID | `No tracking` |
| --debug | Enable debug environment | `False` |
| --ssl | Whether to enable SSL | `5000` |
## Roadmap
Help us by opening a pull request!
- [ ] A docker image
- [ ] Auto-detect input language
- [ ] User authentication / tokens
## Credits
This work is largely possible thanks to [Argos Translate](https://github.com/argosopentech/argos-translate), which powers the translation engine.
## License
[GNU Affero General Public License v3](https://www.gnu.org/licenses/agpl-3.0.en.html)