[docs] Self-Host

[kocobee]

Type of documentation issue

Missing Information

Describe the problem and the proposed solution

It's unclear how we can self-host unkey. Is there any existing documentation that I can take a look at?

[linear]

ENG-1276 [docs] Self-Host

[perkinsjr]

We currently don't have full documentation on how to host Unkey.

Hosting the agent which is probably one of the most critical parts is talked about here:

https://www.unkey.com/docs/contributing/services/agent/configuration

However a detailed end to end self host is very much needed and we plan to add it in the future.

[perkinsjr]

I found a self-hosting issue/request from over a year ago as well, along with how there's a plan to add it in the near future. Seeing that it's now a year later is somewhat discouraging.

The doc you linked is pretty bare-bones, and the note about being out of date isn't encouraging.

I think I'll have to look at alternative solutions. Thanks

To be clear, the out of date note there is as precaution the doc is up to date and you should be using the actual checked out code to configure the agent.

Can I ask why you want to self host the product versus using the cloud service?

[ali-master]

Hi there

We are an enterprise banking application looking to implement a self-hosted solution. Would you be willing to assist us in fully implementing the system?

[perkinsjr]

Hi @ali-master

We can absolutely assist you with this.

You can send me an email at [email protected] and we can set up a call to discuss how to self host and any questions you might have.

[kocobee]

Okay, I think I was able to get what I needed for now. Will reach out if I run into issues.

[ali-master]

Hi there again,

How can I run the dashboard connected to the backend APIs via Docker Compose? it seems that the docker-compose in deployment folder is not complete

[chronark]

@ali-master it's not in the compose file yet, only cause it's not really necessary for testing. We should probably add it

you can run the dashboard via pnpm local, which starts the required containers automatically