Skip to content

Latest commit

 

History

History
154 lines (95 loc) · 7.95 KB

README.md

File metadata and controls

154 lines (95 loc) · 7.95 KB

mjkaye's logo

Mycroft AI running on slimified Debian Linux

Build Status

Mycroft AI version Debian slim version Github repository Docker pulls

What is Mycroft AI?

Mycroft AI logo

Mycroft AI is the world's first Free and Open Source (FOSS) voice assistant. You can buy a Mycroft smart speaker from the shop, get hold of a DIY version, or run the software on a device of your choosing--desktop computer, Single Board Computer (including the Raspberry Pi), etc. This Docker image is one such way to do so.

Control technology with your voice.

What is Debian slim?

Debian logo

Debian is an operating system that is comprised mostly of Free and Open Source Software. It is one of the most popular Linux distributions and forms the basis of many others.

Debian slim excludes files that are not often required within a container, such as documentation. This base image is around 25MiB.

Supported architectures

Architecture Tag
amd64/x86_64 latest-amd64
arm32v7/armhf latest-arm
aarch64/arm64 latest-arm64

How to use this image

docker run -d \
  --name mycroft
  -e PULSE_SERVER=unix:/run/user/0/pulse/native \
  -p 8181:8181 \
  -v ${XDG_RUNTIME_DIR}/pulse/native:/run/user/0/pulse/native \
  -v ~/.config/pulse/cookie:/root/.config/pulse/cookie \
  -v config:/root/.mycroft \
  -v skills:/opt/mycroft/skills \
  --restart unless-stopped
  mjkaye/mycroft-debian-slim

Parameters

Container images are configured using parameters passed at run-time (such as those above). These parameters are separated by a colon and indicate <host>:<container> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080.

Parameter Function
-p 8181:8181 grants LAN access to Mycroft (e.g. to send notifications); optional
-e PULSE_SERVER access pulseaudio on the host; see pulse/native volume
-v :...pulse/native shares ...pulse/native with the host
-v :/root/.mycroft persistent storage for configuration
-v :/opt/mycroft/skills persistent storage for installed skills (so that they don't have to be reinstalled every time the container is started)

Pairing

If your audio is configured correctly, you should hear your Mycroft instance giving you a pairing code that you should use at https://home.mycroft.ai

If you don't have audio set up, you can see the pairing code by examining the logs:

docker logs mycroft | grep "Pairing code:"

CLI access

Get access to the container CLI with:

docker exec -it mycroft /bin/bash

From the container's command prompt, start the CLI console with:

mycroft-cli-client

When the image starts, it installs all the requirements for the installed services. This takes some time and Mycroft is not ready until this process has finished.

Support

Changelog

  • 20.2.4: - Upstream release 20.2.4, adapt to new requirements structure.
  • 20.2.3: - Upstream release 20.2.3, stop using virtualenv, include procps for start-mycroft.sh, improvements to README.md, specify Mimic package version.
  • 20.2.2: - Upstream release 20.2.2; rebase to debian:buster-slim; support architectures arm32v7, aarch64, and amd64.

Thank you

Thank you for using mycroft-debian-slim.

Do you like this Docker image? Donations help me to devote more time to improving these images. My current focus is to make this image as small and resource-efficient as possible. Even the smallest donation is a big help.

Donate using Donorbox


Donate using Bitcoin

bc1q2acfmcwrqc9pzttqgwn6nd0t5cncleue6ukfrs


Donate using Ethereum

0x95ab6d374ef0d3a84bb7c767cdf6c77b3b170ba2


Donate using Dash

XxVEjb1uYFnBGLm59eytUHBDWAYTHeyrET


Donate using Monero

49couTFdiXHhmodRY49DSt4uwLb5SK9d8QXoUQh6TmMgAmNhWVjtXzri1Qq2AWzTVxaYqbhbthXi1R7hKxM4cTvSFKrFcv1


Donate using Groestlcoin

grs1q4gu2xfg8q448tlajg8grqkrlw9rjvuz29vctmj


Donate using NANO

nano_1ro9tk49hje9f31r6x869z18rgbiertsc1jgw6siqb6c9cziywk1u4zq766z


Donate using TRON

TTna1P4yTLueZAunmxAu4p4qYZGQ28VTYE