typesense / typesense/typesense

[Question] Create custom API keys upon initialization

Open
#2,395 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

awaiting-reply question
Dominant language
C++
Stars
26.6k
Forks
973
Avg merge
18h 45m
Merged PRs (30d)
4

Description

I haven't found a way to create my own custom API keys upon running the typesense docker image. By that, I don't mean the bootstrap API key, but rather a search-only (for quering), or a write only to a specific collection (for indexing). Is that possible?

The reason I want this is because I use terraform as an infrastructure tool and I would like terraform to generate the API keys for me and store them in a key vault. Now I need to run the typesense container, manually create the keys, and manually input them in a key vault. If it were possible to create custom keys upon initialization, I could manage everything with terraform.

Thank your for a great service!

Contributor guide

Open the contributing guide

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.

Research direction

No source file, test, or entry point is identified. Start by reviewing how the Typesense Docker image initializes and how API keys are created, then assess Terraform-driven creation of search-only and collection-scoped write keys with key-vault storage. Done should establish whether this initialization flow is supported or define the required feature.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, docker, terraform
Domain
authentication, authorization, infrastructure
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.