Command line program and a docker image

[ivandotv]

Hi, excellent package.
This is not an issue, rather I would like to notify you (since there is no other way) of something I've made based on your package.
I've wrapped the grant server in a command-line program, and I've also made a docker image.
I was scratching my own itch when creating this package. So basically now when developing front-end applications locally I could just run one command and have the server up, ready to proxy OAuth requests, the same thing with the docker container if you are into a microservice architecture.
This is the gist of the package:

      this.server = express()
        .set('trust proxy', this.proxy)
        .use(
          session({
            secret: this.sessionSecret,
            saveUninitialized: false,
            resave: false
          })
        )
        .use(parser.urlencoded({ extended: true }))
        .use(grantExpress(configuration))
        .get('/healthcheck', (req, res) => {
          res.sendStatus(200)
        })
        .listen(port, () => {
          console.log(`server started on port ${port}`)
          resolve()
        })

https://github.com/ivandotv/grant-server/blob/eb816d045bfd96760ad70e9c549b1b5dcafea2bc/src/server.ts#L45-L62

Info on using the command line options and the docker image can be found in the readme file.
If you find it usable and up to your standards, could I make a pull request to add the link to the repository in the readme file?

[simov]

Hi @ivandotv, thank you for considering an issue before opening a PR.

I'm treating the main readme as a quick reference about the software project itself. Mainly about configuration and I'd like to clean it up even further.

That being said there is other type of information that I'd like to document somewhere but not in the main readme. Whether that be just another markdown file, a GitHub wiki or a GitBook I don't know yet.

Just to give you an idea about other issues that are still open and pending to be documented somewhere:

• What is grant? Why would I use it? #202 - I'm not linking even my own articles in the main readme because I feel like they fall outside of that concise reference vision I have for the main readme
• SameSite=Strict cookies break the oauth flow (Grant: missing session or misconfigured provider) #199 - important specifics about cookie configuration that fall out of the bare minimum that I want to have in the main readme

Grant relates to a lot of different topics, and potentially large amounts of details, but I try to keep the readme as short as possible.

Your Docker package and CLI tool is definitely interesting and I'll have a look, but in the meantime, until I find a good place for everything, lets keep this issue open 👍

People are looking at the issue tracker as well.

[ivandotv]

No problem.
Thank you for a great package.