Skip to content

Commit

Permalink
Add Docker notes from troubleshooting
Browse files Browse the repository at this point in the history
  • Loading branch information
NeonDaniel committed Mar 10, 2023
1 parent cf1c7c3 commit f8d8aca
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ The `docker` directory contains everything you need to run Neon Core with defaul
## a. Prerequisite Setup
You will need `docker` and `docker-compose` available. Docker provides updated guides for installing
[docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/).
> *Note*: At this time, Neon is not tested with Docker Desktop. This may change
> in the future, but it is currently recommended NOT to install Docker Desktop.
Neon Core is only tested on Ubuntu, but should be compatible with any linux distribution that uses
[PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/).

Expand Down Expand Up @@ -60,7 +63,9 @@ The GUI is available with instructions [on GitHub](https://github.com/MycroftAI/
## c. Interacting with Neon
With the containers running, you can interact with Neon by voice (i.e. "hey Neon, what time is it?"), or using one of
our CLI utilities, like [mana](https://pypi.org/project/neon-mana-utils/) or the
[neon_cli_client](https://pypi.org/project/neon-cli-client/).
[neon_cli_client](https://pypi.org/project/neon-cli-client/). If using the CLI
client, you can run `neon-cli --logs-dir xdg/state/neon/` from the directory
containing `docker-compose.yml` to see logs in the CLI.
You can view module logs via docker with:

```shell
Expand Down

0 comments on commit f8d8aca

Please sign in to comment.