Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Quick Start Instructions #268

Merged
merged 4 commits into from
Aug 19, 2022
Merged

Update Quick Start Instructions #268

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb68d01
Add note regarding docker user permissions
NeonDaniel Aug 5, 2022
abbea78
Add newgrp call to example to reload permissions in current shell
NeonDaniel Aug 5, 2022
5c21b1f
Add note regarding hidden files in quick start
NeonDaniel Aug 8, 2022
0c11788
Revert GUI link to appropriate repo
NeonDaniel Aug 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,17 @@ You will need `docker` and `docker-compose` available. Docker provides updated g
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/).

> *Note*: By default, only the `root` user has permissions to interact with Docker under Ubuntu.
> To allow the current user to modify Docker containers, you can add them to the `docker` group with:
> `sudo usermod -aG docker $USER && newgrp`

## b. Running Neon
You can clone the repository, or just copy the `docker` directory contents onto your local system; this document will
assume that the repository is cloned to: `~/NeonCore`.

> *Note*: The `docker` directory includes required hidden files. If you copy files, make sure to include any hidden
> files. In must Ubuntu distros, you can toggle hidden file visibility in the file explorer with `CTRL` + `h`.

You can start all core modules with:
```shell
# cd into the directory containing docker-compose.yml
Expand Down Expand Up @@ -94,7 +101,7 @@ to:
```

## e. Configuration
The `ngi_local_conf.yml` file included in the `docker` directory contains a default configuration
The `neon.yaml` file included in the `docker` directory contains a default configuration
that may be modified to specify different plugins and other runtime settings.
The `docker` directory is mounted read-only to `/config` in each of the containers,
so model files may be placed there and the configuration updated to use different STT/TTS plugins with
Expand Down