vriteio / vrite

Open-source developer content platform
https://vrite.io
Other
1.62k stars 64 forks source link

chore: make github app optional #33

Closed Eun closed 1 year ago

Eun commented 1 year ago

Hey, I am trying to self host vrite and wondered if selfhosters really need all the dependencies the full app on vrite.io needs.

So this (if you accept this pr) would be the first pr of a series of pull requests to disable all the fancy stuff a self hoster probably not need or want.

areknawo commented 1 year ago

Hey, thanks for the PR.

That's the first external one, so I'm definitely very grateful ❤️

That said, I've been working on a docker-compose.yml file and a proper guide for self-hosting this week, so good timing 🙂 I hope to have it released next week around Tuesday (definitely docker-compose.yml and hopefully the docs) and this will absolutely include optional env vars.

Here's the plan:

The PR makes the properties optional and only omits the GitHub App connection plugin, while technically, omitting the GitHub App (at least for now), disables the entire Git sync feature. So, while it shouldn't be breaking, there can still be unexpected errors when trying to use the Git sync panel from the UI.

TL;DR; You'll likely want to wait till next week. But also, let me know if you have any suggestions to make the self-hosting experience better, considering the above plan.

Eun commented 1 year ago

These are great news, thanks!

All the steps you mentioned make total sense.

Ill close this pr since it wont be needed any more. :)