Skip to content

The censorship monitoring project (blocked.org.uk) API, database and message-queueing system

License

Notifications You must be signed in to change notification settings

openrightsgroup/Blocking-Middleware

Repository files navigation

Blocked.org.uk Middleware

API Specification

Database Specification

Using the docker development seutp

To start a development instance, install docker and docker-compose and run:

docker-compose --profile dev up

(requires docker-compose v1.29)

This will start containers for:

  • The main API (on localhost:8080)
  • Postgres database
  • RabbitMQ messaging
  • System daemons:
    • results recorder
    • whois checker
    • category importer
    • metadata gatherer
    • robots.txt checker
  • Example web client (on localhost:8081)

You can use the example web client by visiting http://localhost:8081/example-client/

The postgres database is loaded with the main schema, as well as some example data to get started.

Get involved!

We welcome new contributors especially - we hope you find getting involved both easy and fun. All you need to get started is a github account.

Please see our issues repository for details on how to join in.

Credits

We reused the following software components to make this:

Thanks!