Easier more clear instructions on what exactly is needed to deploy

[airtonix]

it seems like the deploy instructions indicate that we have at least one required step:

• create an admin repo add settings yaml files.

Then it's not clear which of the following we have to choose:

• add some existing hosted safe-settings app to our org?
• simply run docker run --rm -it -e APP_ID=*** -e GH_ORG=*** yadhav/safe-settings:2.0.9
• fork the repo, clone it locally and go through all the pain in the ass stuff related to npm install, then develop some way to host this.
• fork the repo, clone it locally and decide to deploy it to some k8s cluster
• fork the repo, clone it locally and decide to deploy it to aws/serverless

Currently the documentation around deployment is very confusing when trying to understand what's needed depending on which of the above you want to do.

• does .1 even exist?
• as in .2 if we just want to run a docker container... can we just get away with specifying -e ...

Furthermore, there is contained in the documentation, language that seems to create confusion for first timers to github apps:

• talk about "manifest flow", indicate there are hard ways and easy ways to setup the app. when following the links to "manifest flow" we end up on a page that then talks about using npx create... which would have us creating another repo... so now we have three repos, the admin repo, the safe-settings repo we forked, and now this other repo that you're telling us to make because: "just follow the manifest flow"

really what I'd like, is to only have an admin repo and then just join an existing app to my org.

[decyjphr]

Hi, for .1 there is a hosted version but that not suited for enterprises because of availability and security reasons. Here is the related issue #260

The second option

simply run docker run --rm -it -e APP_ID=*** -e GH_ORG=*** yadhav/safe-settings:2.0.9

is totally doable.
first, create the GH App following this steps.
then you can run

docker run --rm -it -e APP_ID=*** -e PRIVATE_KEY=<base 64 encoded private key> -e WEBHOOK_SECRET=mysecret yadhav/safe-settings:2.0.9

[airtonix]

@decyjphr amazing, would you be open to receiving a PR that helps introduces new documentation with a "tldr quick start minimum required" sort of section ?

[bheemvennapureddy]

I echo what @airtonix said - documentation is very confusing

[decyjphr]

Yes, feel free to provide better documentation. No worries.