diff --git a/.env.example b/.env.example index 8058653..a602078 100644 --- a/.env.example +++ b/.env.example @@ -1,58 +1,81 @@ # connectd environment variables # copy to .env and fill in your values -# === REQUIRED FOR LLM DRAFTING === +# === REQUIRED === GROQ_API_KEY= -GROQ_MODEL=llama-3.1-70b-versatile +GROQ_MODEL=llama-3.3-70b-versatile -# === DISCOVERY SOURCES === -# github (optional - works without token but rate limited) +# === DISTRIBUTED MODE (optional) === +# for coordinating multiple connectd instances +CONNECTD_CENTRAL_API= +CONNECTD_API_KEY= +CONNECTD_INSTANCE_ID= +CONNECTD_INSTANCE_IP= + +# === DISCOVERY: GITHUB === +# works without token but heavily rate limited GITHUB_TOKEN= -# mastodon (for DM delivery) +# === DISCOVERY: FEDIVERSE === MASTODON_TOKEN= -MASTODON_INSTANCE=mastodon.social +MASTODON_INSTANCE= -# bluesky (for DM delivery) -BLUESKY_HANDLE= -BLUESKY_APP_PASSWORD= - -# matrix (for DM delivery) -MATRIX_HOMESERVER= -MATRIX_USER_ID= -MATRIX_ACCESS_TOKEN= - -# discord (for discovery + DM delivery) -DISCORD_BOT_TOKEN= -DISCORD_TARGET_SERVERS= # comma separated server IDs - -# lemmy (for authenticated access to your instance) LEMMY_INSTANCE= LEMMY_USERNAME= LEMMY_PASSWORD= -# === EMAIL DELIVERY === +# === DISCOVERY: OTHER === +DISCORD_BOT_TOKEN= +DISCORD_TARGET_SERVERS= + +# === DELIVERY: EMAIL === SMTP_HOST= SMTP_PORT=465 SMTP_USER= SMTP_PASS= -FROM_EMAIL=connectd +FROM_EMAIL= + +# === DELIVERY: SOCIAL === +# mastodon - reuses discovery token above +# MASTODON_TOKEN= +# MASTODON_INSTANCE= + +BLUESKY_HANDLE= +BLUESKY_APP_PASSWORD= + +MATRIX_HOMESERVER= +MATRIX_USER_ID= +MATRIX_ACCESS_TOKEN= + +# === DELIVERY: FORGE ISSUES === +# for creating issues on self-hosted git forges +# highest signal outreach - these people actually selfhost + +# codeberg (largest public gitea instance) +CODEBERG_TOKEN= + +# gitea/forgejo instances - format: GITEA_TOKEN_=token +# examples: +# GITEA_TOKEN_git_example_com=your-token +# GITEA_TOKEN_192_168_1_8_3000=your-token + +# gitlab CE instances - format: GITLAB_TOKEN_=token +# examples: +# GITLAB_TOKEN_gitlab_example_com=your-token # === HOST USER CONFIG === -# the person running connectd - gets priority matching -# set HOST_USER to your github username and connectd will auto-discover your info -# other vars override/supplement discovered values +# you - gets priority matching and appears in intros HOST_USER= HOST_NAME= HOST_EMAIL= -HOST_GITHUB= # defaults to HOST_USER -HOST_MASTODON= # format: @user@instance +HOST_GITHUB= +HOST_MASTODON= HOST_REDDIT= -HOST_LEMMY= # format: @user@instance +HOST_LEMMY= HOST_LOBSTERS= -HOST_MATRIX= # format: @user:server -HOST_DISCORD= # user id -HOST_BLUESKY= # format: handle.bsky.social +HOST_MATRIX= +HOST_DISCORD= +HOST_BLUESKY= HOST_LOCATION= -HOST_INTERESTS= # comma separated: intentional-community,cooperative,solarpunk -HOST_LOOKING_FOR= # what you're looking for in matches +HOST_INTERESTS= +HOST_LOOKING_FOR=