Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 2.08 KB

installation.md

File metadata and controls

52 lines (43 loc) · 2.08 KB

InkyPi Detailed Installation

Flashing Raspberry Pi OS

  1. Install the Raspberry Pi Imager from the official download page
  2. Insert the target SD Card into your computer and launch the Raspberry Pi Imager software
    • Raspberry Pi Device: Choose your Pi model
    • Operating System: Select the recommended system
    • Storage: Select the target SD Card

Raspberry Pi Imager

  1. Click Next and choose Edit Settings on the Use OS customization? screen
    • General:
      • Set hostname: enter your desired hostname
        • This will be used to ssh into the device & access the InkyPi UI on your network.
      • Set username & password
        • Do not use the default username and password on a Raspberry PI as this poses a security risk
      • Configure wireless LAN to your network
        • The InkyPi web server will only be accessible to devices on this network
      • Set local settings to your Time zone
    • Service:
      • Enable SSH:
        • Use password authentication
    • Options: leave default values

  1. Click Yes to apply OS customization options and confirm

Storing API Credentials

Certain plugins, like the AI Image plugin, require API credentials to function. These credentials must be stored in a .env file located at the root of the project. Once you have your API token, follow these steps:

  1. SSH into your Raspberry Pi and navigate to the InkyPi directory: 
    cd InkyPi
  2. Create or edit the .env file using your preferred text editor (e.g., vi, nano): 
    vi .env
  3. Add the required API key and token in the following format: 
    {plugin_key}={your_token}
    For the AI Image plugin, the plugin_key would be OPEN_AI_SECRET.
  4. Save and exit the editor