ONSdigital/dp-zebedee-content

dp-zebedee-content

Command line tool generating default content required to run Zebedee CMS.

Prerequisites

• Go version >= 1.19
• Access to the AWS Sandbox account

AWS dev account access

• Ensure you select the Sandbox account before running this app, in order for this application to access the S3 bucket: ons-dp-sandbox-developer-cms-content

Without AWS dev account access

Alternatively, if you do not have access to the Sandbox account, you may request the cms-contents.zip file from a colleague.

Getting started

dp-zebedee-content is a Go Module so needs to be cloned to a directory outside of your $GOPATH

git clone git@github.com:ONSdigital/dp-zebedee-content.git

Install

make install

(Optional) Place content zip file

If you do not have access to the AWS Sandbox account and you have a cms-contents.zip file, please place it to the path where you want your contents:

cp cms-contents.zip ~/path_where_you_want_the_content_to_be_generated

The program will skip the download step if it finds the cms-contents.zip file in the content folder, and will use it instead.

Run

dp-zebedee-content generate -c=~/path_where_you_want_the_content_to_be_generated

See Flags for further details.

The generate command will:

• Generate the directory structure required by Zebedee-CMS.
• Populate the CMS with default content.
• Generates default user, teams, permissions and service token content.

Note It's safe to run the generate command multiple times. Doing so will overwrite any previously generated content and reset the CMS content, users, teams etc. to the default state.

Flags

Flag	Description	Example
h / help	Display the help menu.
c / content	The output directory the generated content will be written - this can be anywhere you like. If unset, the zebedee_root env var will be attempted instead.	~/Desktop/zebedee-content/generated (~ prefix will be expanded).

Once you have run generator add the output zebedee_root and SERVICE_AUTH_TOKEN values to your ENV vars. You should now have the required directories, content and configurations to run a local copy of Zebedee CMS.

Help/Issues

If you experience any problems with this tool please speak to a member of the dev team. If you believe there is a defect or issue with the code you can either:

• Raise a github issue.
• Open pull request.

Please be sure to provide a description of the problem and steps to recreate.

Kind regards

The Dev team