Add the CurseForge API key from the dashboard

Open
#178 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
65/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
docker-compose, typescript
Domain
full-stack

Research direction

Find where CURSEFORGE_API_KEY is loaded from env and where settings persist (likely a settings module and isopod_settings.json). Add a dashboard Settings field with link to CurseForge console, trim input, validate via CurseForge API, and ensure saved key overrides env without restart. Done when all acceptance criteria pass and key is never exposed in API or files.

Written by the indexing model from the issue text.

Description

Summary

Let users add their CurseForge API key from the dashboard, so it works right after pasting it from console.curseforge.com, with no .env editing and no restart.

Why

Today the key has to go in .env or a compose file. Keys start with $2a$10$, so an unquoted key is silently cut short by Docker Compose, and nothing tells the user their key is bad until a search fails with a 403.

Acceptance Criteria

  • Settings has a place to paste the key, with a link to the CurseForge console.
  • Pasted whitespace and surrounding quotes are ignored.
  • The key is checked against CurseForge before it's saved, and a rejected key gives a clear message.
  • A saved key works right away, with no restart of Isopod, including for servers started afterwards.
  • A saved key takes priority over CURSEFORGE_API_KEY, and removing it falls back to that variable.
  • The key is never returned by the API or written to isopod_settings.json or instance compose files.
  • When CurseForge can't be used because of the key, the dashboard points to the new setting.
Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
13h 12m
Merged PRs (30d)
57

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Isopod-Project/Isopod

All issues in Isopod-Project/Isopod

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.