Skip to content
This repository has been archived by the owner on Dec 20, 2023. It is now read-only.


Cole Anthony Capilongo edited this page Nov 30, 2017 · 18 revisions

1. Register at Amazon

First you need to obtain a set of credentials from Amazon to use the Alexa Voice service. Make a note of these credentials as you will be asked for them during the install process. Make sure to record both security IDs, descriptions, etc. and ones for the device.

  • Login at and go to Alexa then Your Alexa dashboards (top right) then ALEXA, then Alexa Voice Service.

  • Register a Product Type > Device.

  • You are at Device Type Info left tab.

    • For the Device Type ID and Display Name use something like AlexaPi or whatever you want.
    • Next
  • You are at Security Profile left tab.

    • From the drop-down menu choose Create a new profile.
    • Choose whatever for Security Profile Name and Security Profile Description. Hit Next.
    • Under Web:
      • Allowed Origins - put there http://localhost:5050 and http://ALEXA.DEVICE.IP.ADDRESS:5050
      • Allowed Return URLs put http://localhost:5050/code and http://ALEXA.DEVICE.IP.ADDRESS:5050/code. You have to replace ALEXA.DEVICE.IP.ADDRESS with the IP (for example of your AlexaPi device (for example Raspberry Pi). This is especially necessary when you are installing from another computer than AlexaPi is gonna run on.
  • You should now be at the devices page

  • Click Manage beside your new device

  • Click Capabilities and then enable timers and Cards > Cards with text only

  • Click Update.

2. Install AlexaPi

NOTE: For Windows, continue at

  1. Boot your PC and login to a command prompt.

  2. Make sure you are in /opt by issuing

    cd /opt
  3. Make sure you have git installed

    sudo apt-get install git # For Debian OSs (Debian, Raspbian, OSMC, OpenElec...)
    sudo pacman -Sy git # For Arch Linux
  4. Clone this repo

    sudo git clone

    NOTE: You can also clone the repository to any other directory (and lose the sudo here, if you have permission to write to that directory), but you won't be able to run AlexaPi on boot with our init scripts. It is therefore recommended for advanced users (who know what they're doing) only.

  5. Run the setup script

    sudo ./AlexaPi/src/scripts/

    Follow instructions...

3. Post-installation steps

Now that you have installed AlexaPi there's a couple of things you need to do.


  • Reboot your machine or start AlexaPi with

    sudo systemctl start AlexaPi.service
  • Check the status of AlexaPi with

    sudo systemctl status AlexaPi.service

    If it is not running, be sure to see the full logs.

  • In a lot of cases, you have to setup your input / output devices properly in the configuration file. Read the Audio setup & debugging section in the documentation.

  • If you have a desktop OS (such as default Raspbian), you have to set up system-wide PulseAudio. You usually get dbus and pulseaudio error in the log if you don't do this.

  • If you got this working, but audio playback is choppy, try changing the playback handler in the config from vlc to sox. This will be default in later versions of AlexaPi. If you're using pulseaudio, please read audio setup guide.


Enjoy :)