The publishing platform used for the ONS website.
![Florence screenshot](images/Florence screenshot.png)
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:
- Move into the correct directory
- 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:
brew install vault
vault server -dev
Browse to the Florence homepage http://localhost:8081/florence
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: email@example.com Password: Doug4l
Further guidance on how to use Florence can be found in usage.md
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)
- Update JS, CSS and other source file changes
The following environment variables are available when running the Go server.
|BIND_ADDR||:8080||Host and port to bind to. Note: running
|ROUTER_URL||http://localhost:20000||URL that the frontend router can be accessed on|
|ZEBEDEE_URL||http://localhost:8081||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|
|TABLE_RENDERER_URL||http://localhost:23300||The URL that dp-table-renderer can be accessed on|
|UPLOAD_BUCKET_NAME||dp-frontend-florence-file-uploads||Name of the S3 bucket that dataset uploads are sent to|
|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)|
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>`
See CONTRIBUTING for details.
Copyright © 2016-2017, Office for National Statistics (https://www.ons.gov.uk)
Released under MIT license, see LICENSE for details.