From 55613042243c3beba4ea0eb353d24afab82ed17d Mon Sep 17 00:00:00 2001 From: Ryan Burnette Date: Sat, 26 Sep 2020 11:56:23 -0400 Subject: [PATCH] work --- README.md | 45 ++++++++++++++++----------------------------- 1 file changed, 16 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index cfd7f27..a5f57c4 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,23 @@ -# cdadmin +# [git-deploy](https://git.ryanburnette.com/ryanburnette/git-deploy) -**cdadmin** is administration app for continuous deployment of static websites. +**git-deploy** is an app for handling continuous deployment of static websites. -**cdadmin** is intended to be used with static websites that are generated after +**git-deploy** is intended for use with static websites that are generated after changes are pushed to a Git repository. This works with sites that are being -edited in code and tracked in Git, as well as with headless CMSs that are -pushing changes via Git. +edited in code and tracked in Git. Sites that have their content managed with a +headless CMS that pushes to Git are also very well-suited. -cdadmin starts a web server that provides an admin interface as well as an API. +Github, Bitbucket, and Gitea are natively supported via webhooks. -No authentication is provided, so you'll want to reverse proxy through something -that protects the endpoints. +**git-deploy** is written in Go. This means that it's a standalone binary +available on all major operating systems and architectures. It provides an API +with endpoints that handle webhooks, allow for initiation of builds, and getting +the status of builds and build jobs. -## Admin +**git-deploy** comes with a simple interface. The interface be disabled if you +don't want to use it. -The main page of the admin show the staging and production rebuild status. It -allows the user to queue a rebuild of the staging and production environments. -It also allows the user to merge staging into production. - -- Handles webhooks that rebuild staging -- Gives admin a button to rebuild staging -- Gives users feedback on the staging rebuild status -- Handles webhooks that rebuild production -- Gives admin a button to rebuild production -- Gives users feedback on the production rebuild status -- Gives users a button to rebase production on staging (did I say that - correctly?) - -## Email - -Need to support at least the following for sending email. - -- SMTP -- Amazon SES -- Mailgun +**git-deploy** also comes with basic authentication via integration with +[Pocket ID](https://pocketid.app). Authentication can also be disabled if you +don't want to use it. The built-in interface requires the built-in +authentication.