Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/OpenVoiceOS/ovos-local-backend
personal backend - self-hosted backend to manage multiple OVOS devices
https://github.com/OpenVoiceOS/ovos-local-backend
backend flask hacktoberfest mycroft openvoiceos ovos python self-hosted
Last synced: about 2 months ago
JSON representation
personal backend - self-hosted backend to manage multiple OVOS devices
- Host: GitHub
- URL: https://github.com/OpenVoiceOS/ovos-local-backend
- Owner: OpenVoiceOS
- License: apache-2.0
- Created: 2018-01-10T00:37:17.000Z (over 6 years ago)
- Default Branch: dev
- Last Pushed: 2024-01-31T16:39:37.000Z (8 months ago)
- Last Synced: 2024-08-03T13:02:16.110Z (about 2 months ago)
- Topics: backend, flask, hacktoberfest, mycroft, openvoiceos, ovos, python, self-hosted
- Language: Python
- Homepage:
- Size: 38.4 MB
- Stars: 78
- Watchers: 17
- Forks: 26
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ovos-plugins - ovos-local-backend - permissevely licensed alternative to the official mycroft backend (Projects using OPM / Audio Transformers)
README
# OVOS Personal Backend
Personal backend for OpenVoiceOS, written in flask
This allows you to manage multiple devices from a single location
:warning: there are no user accounts :warning:
Documentation can be found at https://openvoiceos.github.io/community-docs/personal_backend
NOTES:
- this backend moved to SQL databases on release 0.2.0, json databases from older version are not compatible
- at the time of writing, backend manager does not yet work with this backend version
- backend-client now includes a CRUD api to interact with databases https://github.com/OpenVoiceOS/ovos-backend-client/pull/30
## Install
from pip
```bash
pip install ovos-local-backend
```
## Companion projects
- [ovos-backend-client](https://github.com/OpenVoiceOS/ovos-backend-client) - reference python library to interact with backend
- [ovos-backend-manager](https://github.com/OpenVoiceOS/ovos-backend-manager) - graphical interface to manage all things backend
- [ovos-stt-plugin-selene](https://github.com/OpenVoiceOS/ovos-stt-plugin-selene) - stt plugin for selene/local backend (DEPRECATED)
You can use this backend as a STT server proxy via [ovos-stt-plugin-server](https://github.com/OpenVoiceOS/ovos-stt-plugin-server), eg `https://your_backend.org/stt`
## Configuration
configure backend by editing/creating ```~/.config/ovos_backend/ovos_backend.conf```
```json
{
"lang": "en-us",
"date_format": "DMY",
"system_unit": "metric",
"time_format": "full",
"location": {
"city": {"...": "..."},
"coordinate": {"...": "..."},
"timezone": {"...": "..."}
},
"stt_servers": ["https://stt.openvoiceos.org/stt"],
"server": {
"admin_key": "leave empty to DISABLE admin api",
"port": 6712,
"database": "sqlite:////home/user/.local/share/ovos_backend.db",
"skip_auth": false,
"geolocate": true,
"override_location": false,
"version": "v1"
},
"listener": {
"record_utterances": false,
"record_wakewords": false
},
"microservices": {
"wolfram_key": "$KEY",
"owm_key": "$KEY",
"email": {
"recipient": "",
"smtp": {
"username": "",
"password": "",
"host": "smtp.mailprovider.com",
"port": 465
}
}
}
}
```
database can be sqlite or mysql
eg. `mysql+mysqldb://scott:[email protected]/test?ssl_ca=/path/to/ca.pem&ssl_cert=/path/to/client-cert.pem&ssl_key=/path/to/client-key.pem`
## Docker
There is also a docker container you can use
```bash
docker run -p 8086:6712 -d --restart always --name local_backend ghcr.io/openvoiceos/local-backend:dev
```