api_keys.md

Storing API Keys

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 your API keys following format, with one line per key:

   PLUGIN_KEY=your-key
   

4. Save the file and exit the editor

Open AI Key

Required for the AI Image and AI Text Plugins

• Login or create an account on the Open AI developer platform
• Crate a secret key from the API Keys tab in the Settings page
  • It is recommended to set up Auto recharge (found in the "Billing" tab)
  • Optionally set a Budge Limit in the Limits tab
• Store your key in the .env file with the key OPEN_AI_SECRET

  OPEN_AI_SECRET=your-key
  

Open Weather Map Key

Required for the Weather Plugin

• Login or create an account on OpenWeatherMap
  • Verify your email after signing up
• The weather plugin uses the One Call API 3.0 which requires a subscription but is free for up to 1,000 requests per day.
  • Subscribe at One Call API 3.0 Subscription
  • Follow the instructions to complete the subscription.
  • Navigate to Your Subscriptions and set "Calls per day (no more than)" to 1,000 to avoid exceeding the free limit
• Store your api key in the .env file with the key OPEN_WEATHER_MAP_SECRET

  OPEN_WEATHER_MAP_SECRET=your-key
  

NASA Astronomy Picture Of the Day Key

Required for the APOD Plugin

• Request an API key on NASA APIs
  • Fill your First name, Last name, and e-mail address
• The APOD plugin uses the NASA APIs
  • Free for up to 1,000 requests per hour
• Store your api key in the .env file with the key NASA_SECRET

  NASA_SECRET=your-key
  

Unsplash Key

Required for the Unsplash Plugin

• Register an account from https://unsplash.com/developers
• Go to https://unsplash.com/oauth/applications
• Create an app and open it
• Your KEY is listed as Access Key
• Store your api key in the .env file with the key UNSPLASH_ACCESS_KEY

  UNSPLASH_ACCESS_KEY=your-key
  

GitHub Key

Required for the GitHub Plugin

• Login to your Github profile https://github.com/settings/profile
• Under Developer Settings, create a new Personal access token (classic)
• Assign the read:user scope and generate the token
• Store your api key in the .env file with the key GITHUB_SECRET

  GITHUB_SECRET=your-key
  

Immich Key

Required for the Image Album plugin for the Immich Provider

• Login to your Immich instance https://my.immich.app/
• Under Account Settings > API Keys, create a new API Key
• Assign the asset.read, asset.download, and album.read permissions and generate the key
• Store your api key in the .env file with the key IMMICH_KEY

  IMMICH_KEY=your-key