Nicholai/jan

Daniel 0c13067420 Migrate ADRs to specs

2023-11-03 16:15:54 +07:00

2.1 KiB

Raw Blame History

ADR #001: Jan deployable cloud-native

Changelog

23.10.03: Initial unfinished draft
23.10.16: Remove authentication

Authors

@nam-john-ho
@louis

Context

Status Quo

User doesn't have a local GPU machine but wants to run Jan on a rented server
User wants a quick, fast way to experiment with Jan on a rented GPU
https://github.com/janhq/jan/issues/255

Decision

This ADR aims to outline design decisions for deploying Jan in cloud native environments such as: Runpod, AWS, Azure, GCP in a fast and simple way.
The current code-base should not change too much.
The current plugins must be reusable across enviroments (Desktop, Cloud-native).

Key Design Decisions

Why middleware

The /web codebase needs to operate in both browser and electron environments
The /web codebase needs to route plugin routes accordingly, either to /server or /electron
Middleware takes care of this
We will have a /server codebase that takes care of routing to plugins

Unsuitable Alternatives

Not possible to just run electron headless
/web is on a different chromium window
Does not have all the electron handlers
Does not have the IPC handler

Alternative Approaches

Separated server process runs along side with electron. 6005409a94

Considerations

Due to the limitation of accessing the file system in web browsers, the first version of the web app will load all the current plugins by default, and users will not be able to add, remove, or update plugins.
Simple authentication will be implemented as a plugin.

References