darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-02 08:25:15 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #620 from GSA/minor-readme-updates

Browse Source 
Minor README.md updates
This commit is contained in:
Carlo Costino
2023-11-22 14:02:17 -05:00
committed by GitHub
parent 17025c7a10 844cab2e3d
commit 6fc1617528
2 changed files with 31 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -1,16 +1,16 @@
# US Notify API
# Notify.gov API
This project is the core of [Notify](https://notifications-admin.app.cloud.gov/).
This project is the core of [Notify.gov](https://notify-demo.app.cloud.gov).
It's cloned from the brilliant work of the team at
[GOV.UK Notify](https://github.com/alphagov/notifications-api), cheers!
This repo contains:
- A public-facing REST API for Notify, which teams can integrate with using
[API clients built by UK](https://www.notifications.service.gov.uk/documentation)
- A public-facing REST API for Notify.gov, which teams can integrate with using
[API clients built by UK](https://www.notifications.service.gov.uk/documentation).
- An internal-only REST API built using Flask to manage services, users,
templates, etc., which the [admin UI](http://github.com/18F/notifications-admin)
talks to)
templates, etc., which the
[Notify.gov Admin UI](http://github.com/18F/notifications-admin) talks to.
- Asynchronous workers built using Celery to put things on queues and read them
off to be processed, sent to providers, updated, etc.
@@ -123,11 +123,13 @@ configuration after installation to get working out of the box:
asynchronous job processing
- [vim](https://www.vim.org/) - for editing files more easily in the command
line
- [wget](https://www.gnu.org/software/wget/) - for retrieving files in the
command line
You can install them by running the following:
```sh
brew install jq git tfenv cloudfoundry/tap/cf-cli@8 redis vim
brew install jq git tfenv cloudfoundry/tap/cf-cli@8 redis vim wget
```
#### Terraform Installation
@@ -428,7 +430,7 @@ instructions above for more details.
- [Queues and tasks](./docs/all.md#queues-and-tasks)
- [Priority queue](./docs/all.md#priority-queue)
- [Celery scheduled tasks](./docs/all.md#celery-scheduled-tasks)
- [US Notify](./docs/all.md#us-notify)
- [Notify.gov](./docs/all.md#us-notify)
- [System Description](./docs/all.md#system-description)
- [Run Book](./docs/all.md#run-book)
- [ Alerts, Notifications, Monitoring](./docs/all.md#-alerts-notifications-monitoring)
@@ -446,8 +448,14 @@ instructions above for more details.
## License && public domain
Work through [commit `e604385`](https://github.com/GSA/notifications-api/commit/e604385e0cf4c2ab8c6451b7120ceb196cce21b5) is licensed by the UK government under the MIT license. Work after that commit is in the worldwide public domain. See [LICENSE.md](./LICENSE.md) for more information.
Work through
[commit `e604385`](https://github.com/GSA/notifications-api/commit/e604385e0cf4c2ab8c6451b7120ceb196cce21b5)
is licensed by the UK government under the MIT license. Work after that commit
is in the worldwide public domain. See [LICENSE.md](./LICENSE.md) for more
information.
## Contributing
As stated in [CONTRIBUTING.md](CONTRIBUTING.md), all contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.
As stated in [CONTRIBUTING.md](CONTRIBUTING.md), all contributions to this
project will be released under the CC0 dedication. By submitting a pull request,
you are agreeing to comply with this waiver of copyright interest.

26
docs/all.md
View File

@@ -33,7 +33,7 @@
- [Queues and tasks](#queues-and-tasks)
- [Priority queue](#priority-queue)
- [Celery scheduled tasks](#celery-scheduled-tasks)
- [US Notify](#us-notify)
- [Notify.gov](#us-notify)
- [System Description](#system-description)
- [Run Book](#run-book)
- [ Alerts, Notifications, Monitoring](#-alerts-notifications-monitoring)
@@ -694,13 +694,13 @@ make run-celery-beat
US Notify
Notify.gov
=========
System Description
------------------
US Notify is a service being developed by the TTS Public Benefits Studio to increase the availability of
Notify.gov is a service being developed by the TTS Public Benefits Studio to increase the availability of
SMS and email notifications to Federal, State, and Local Benefits agencies.
Agencies that sign up will be able to create and use personalized message templates for sending
@@ -710,23 +710,23 @@ or services.
The templates are sent by the agency using one of two methods:
* using the US Notify API to send a message to a given recipient with given personalization values
* using the US Notify website to upload a CSV file of recipients and their personalization values, one row per message
* using the Notify.gov API to send a message to a given recipient with given personalization values
* using the Notify.gov website to upload a CSV file of recipients and their personalization values, one row per message
### Environment
US Notify is comprised of two applications both running on cloud.gov:
Notify.gov is comprised of two applications both running on cloud.gov:
* Admin, a Flask website running on the python_buildpack which hosts agency user-facing UI
* API, a Flask application running on the python_buildpack hosting the US Notify API
* API, a Flask application running on the python_buildpack hosting the Notify.gov API
US Notify utilizes several cloud.gov-provided services:
Notify.gov utilizes several cloud.gov-provided services:
* S3 buckets for temporary file storage
* Elasticache (redis) for cacheing data and enqueueing background tasks
* RDS (PostgreSQL) for system data storage
US Notify also provisions and uses two AWS services via a [supplemental service broker](https://github.com/GSA/usnotify-ssb):
Notify.gov also provisions and uses two AWS services via a [supplemental service broker](https://github.com/GSA/usnotify-ssb):
* [SNS](https://aws.amazon.com/sns/) for sending SMS messages
* [SES](https://aws.amazon.com/ses/) for sending email messages
@@ -737,7 +737,7 @@ For further details of the system and how it connects to supporting services, se
Run Book
========
Policies and Procedures needed before and during US Notify Operations. Many of these policies are taken from the Notify.gov System Security & Privacy Plan (SSPP).
Policies and Procedures needed before and during Notify.gov Operations. Many of these policies are taken from the Notify.gov System Security & Privacy Plan (SSPP).
Any changes to policies and procedures defined both here and in the SSPP must be kept in sync, and should be done collaboratively with the System ISSO and ISSM to ensure
that the security of the system is maintained.
@@ -840,7 +840,7 @@ Also known as: **How to move code from my machine to production**
1. All PRs must be approved by another developer
1. PRs to `main` and `production` branches must be merged by a someone with the `Administrator` role.
1. PR documentation includes a Security Impact Analysis
1. PRs that will impact the Security Posture must be approved by the US Notify ISSO.
1. PRs that will impact the Security Posture must be approved by the Notify.gov ISSO.
1. Any PRs waiting for approval should be talked about during daily Standup meetings.
### notifications-api & notifications-admin
@@ -940,9 +940,9 @@ Important policies:
| Role Name | Permissions | Who | Responsibilities |
| --------- | ----------- | --- | ---------------- |
| Platform Administrator | `platform_admin` | PBS Fed | Administer system settings within US Notify across Services |
| Platform Administrator | `platform_admin` | PBS Fed | Administer system settings within Notify.gov across Services |
| User Manager | `MANAGE_USERS` | Agency Partner | Manage service team members |
| User | any except `MANAGE_USERS` | Agency Partner | Use US Notify |
| User | any except `MANAGE_USERS` | Agency Partner | Use Notify.gov |
### Service Accounts