florence

README

Florence

The publishing platform used for the ONS website.


Getting started

To run Florence you must have Golang installed on a UNIX machine.

Once you have installed those dependencies and cloned this repo you need to run the following:

1. Move into the correct directory

cd florence

1. Build node modules (you won't need to do this everytime only when the assets need to be rebuilt)

make node-modules

1. Run the server

make debug

Steps 2 & 3 can also be run with the following command:

make dev

This will build the node modules and then run the server

Please note that encryption is enabled by default. To disable it set ENCRYPTION_DISABLED=true. If you wish to run with encryption enabled, you will need vault running locally:

• Run brew install vault
• Run vault server -dev

1. Browse to the Florence homepage http://localhost:8081/florence

2. If you are running Florence for the first time you will need to login with the setup credentials. You will be asked to change this password.

Username: florence@magicroundabout.ons.gov.uk Password: Doug4l

Further guidance on how to use Florence can be found in usage.md

Dependencies

There are other ONS digital applications that you'll need to run to allow Florence to work end-to-end:

• Preview: Babbage
• API: Zebedee CMS
• Preview: Sixteens
• Publishing: The Train
• Dataset upload: Import API
• Dataset upload: Recipes API

Optional (for developing Florence)

• Install NodeJS and NPM
• Watch for JS, CSS and other source file changes

make watch-src

• Update JS, CSS and other source file changes

make node-modules 

Configuration

The following environment variables are available when running the Go server.

Environment variable	Default	Description
BIND_ADDR	:8080	Host and port to bind to. Note: running make debug will run Florence on :8081
ROUTER_URL	http://localhost:20000	URL that the frontend router can be accessed on
ZEBEDEE_URL	http://localhost:8082	URL that Zebedee can be accessed on
IMPORT_API_URL	http://localhost:21800	URL that the dataset import API can be accessed on
RECIPE_API_URL	http://localhost:22300	URL that the dataset recipes API can be accessed on
DATASET_API_URL	http://localhost:22000	URL that the dataset API can be accessed on
TABLE_RENDERER_URL	http://localhost:23300	The URL that dp-table-renderer can be accessed on
AWS_REGION	eu-west-1	S3 region to use. This region has to match the region where the bucket was created.
UPLOAD_BUCKET_NAME	dp-frontend-florence-file-uploads	Name of the S3 bucket that dataset uploads are sent to
DATASET_CONTROLLER_URL	http://localhost:24000	Dataset controller url
ENCRYPTION_DISABLED	false	Determines wether encryption is disabled or enabled
VAULT_ADDR	http://localhost:8200	The URL that vault can be accessed on
VAULT_TOKEN	(secret) generated by Makefile	Vault token
VAULT_PATH	secret/shared/psk	Vault path
ENABLE_DATASET_IMPORT	false	Displays the screens to allow filterable datasets to be imported through Florence (note: it requires the whole CMD stack to be running)
GRACEFUL_SHUTDOWN_TIMEOUT	10s	The graceful shutdown timeout in seconds
HEALTHCHECK_INTERVAL	30s	The period of time between health checks
HEALTHCHECK_CRITICAL_TIMEOUT	90s	The period of time after which failing checks will result in critical global check status

For example:

make debug BIND_ADDR=:20000

AWS configurations are needed for the dataset file upload process, so make sure the credentials are configured correctly for your environment.

export AWS_ACCESS_KEY_ID=<ACCESS_KEY>
export AWS_SECRET_ACCESS_KEY=<SECRET_KEY>`

Contributing

See CONTRIBUTING for details.

License

Copyright © 2016-2017, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.