[GH-ISSUE #1650] [FR] chore(dx): setup karakeep to be able to spin up dev containers #1027

Open
opened 2026-03-02 11:54:29 +03:00 by kerem · 4 comments
Owner

Originally created by @xuatz on GitHub (Jun 21, 2025).
Original GitHub issue: https://github.com/karakeep-app/karakeep/issues/1650

Originally assigned to: @Sozhan308 on GitHub.

Describe the feature you'd like

Inspired by Immich, we could setup karakeep to be able to spin up GitHub dev containers, so that users can easily and quickly start a dev environment on vscode and/or GitHub Codespaces.

Describe the benefits this would bring to existing Karakeep users

While it is almost the same thing as a docker compose based local dev setup, the key difference with a dev containers setup allows for us to spin up Github Codespaces, which is surprisingly useful in unexpected scenarios (speaking from personal experience lol)

Can the goal of this request already be achieved via other means?

Yes. docker compose up and sh start-dev.sh can fulfill the local dev requirement, but dev containers will have more synergy with GitHub Codespaces.

Have you searched for an existing open/closed issue?

  • I have searched for existing issues and none cover my fundamental request

Additional context

We have to decide if we will still keep/maintain the docker compose based local dev setup, if we decide to go ahead with this.

Originally created by @xuatz on GitHub (Jun 21, 2025). Original GitHub issue: https://github.com/karakeep-app/karakeep/issues/1650 Originally assigned to: @Sozhan308 on GitHub. ### Describe the feature you'd like Inspired by [Immich](https://immich.app/docs/developer/devcontainers/), we could setup karakeep to be able to spin up [GitHub dev containers](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers), so that users can easily and quickly start a dev environment on vscode and/or [GitHub Codespaces](https://docs.github.com/en/codespaces/about-codespaces/what-are-codespaces). ### Describe the benefits this would bring to existing Karakeep users While it is almost the same thing as a docker compose based local dev setup, the key difference with a dev containers setup allows for us to spin up Github Codespaces, which is surprisingly useful in unexpected scenarios (speaking from personal experience lol) ### Can the goal of this request already be achieved via other means? Yes. `docker compose up` and `sh start-dev.sh` can fulfill the local dev requirement, but dev containers will have more synergy with GitHub Codespaces. ### Have you searched for an existing open/closed issue? - [x] I have searched for existing issues and none cover my fundamental request ### Additional context We have to decide if we will still keep/maintain the docker compose based local dev setup, if we decide to go ahead with this. #### Related issues(?) * https://github.com/karakeep-app/karakeep/issues/580 * https://github.com/karakeep-app/karakeep/pull/584 * https://github.com/karakeep-app/karakeep/issues/1241 * https://github.com/karakeep-app/karakeep/issues/1290 * #2149
Author
Owner

@Sozhan308 commented on GitHub (Jun 21, 2025):

Hey @xuatz ,

I'd like to take up this task if it's available!

<!-- gh-comment-id:2993706180 --> @Sozhan308 commented on GitHub (Jun 21, 2025): Hey @xuatz , I'd like to take up this task if it's available!
Author
Owner

@xuatz commented on GitHub (Jun 21, 2025):

Hey @xuatz ,

I'd like to take up this task if it's available!

Sure, thanks! Don't forget to take a look at the related issues as well 🫡

<!-- gh-comment-id:2993707609 --> @xuatz commented on GitHub (Jun 21, 2025): > Hey @xuatz , > > I'd like to take up this task if it's available! Sure, thanks! Don't forget to take a look at the related issues as well 🫡
Author
Owner

@HarryPeach commented on GitHub (Jul 20, 2025):

Hey is there any update on this? If there's been any struggle I'd be keen to help

<!-- gh-comment-id:3094740987 --> @HarryPeach commented on GitHub (Jul 20, 2025): Hey is there any update on this? If there's been any struggle I'd be keen to help
Author
Owner

@xuatz commented on GitHub (Jul 24, 2025):

Hey is there any update on this? If there's been any struggle I'd be keen to help

@HarryPeach maybe if we don't get any updates after this weekend you can take over this issue instead 😈

<!-- gh-comment-id:3112989922 --> @xuatz commented on GitHub (Jul 24, 2025): > Hey is there any update on this? If there's been any struggle I'd be keen to help @HarryPeach maybe if we don't get any updates after this weekend you can take over this issue instead 😈
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/karakeep#1027
No description provided.