- Ruby 88.6%
- HTML 10.7%
- Dockerfile 0.7%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .github | ||
| app | ||
| bin | ||
| config | ||
| db | ||
| docs | ||
| lib | ||
| public | ||
| spec | ||
| .dockerignore | ||
| .gitignore | ||
| .govuk_dependabot_merger.yml | ||
| .rspec | ||
| .rubocop.yml | ||
| .ruby-version | ||
| config.ru | ||
| Dockerfile | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENCE | ||
| Procfile | ||
| Rakefile | ||
| README.md | ||
Asset Manager
Manages uploaded assets (images, PDFs etc.) for applications in the GOV.UK Publishing stack.
The app receives uploaded files from publishing applications and returns the URLs that they will be made available at. Before an asset is available to the public, it is virus scanned. Once a file is found to be clean, Asset Manager serves it at the previously generated URL. Unscanned or Infected files return a 404 Not Found error. Deleted files return a 410 Gone response.
Scanning uses ClamAV and occurs asynchronously via govuk_sidekiq.
Technical Documentation
This is a Ruby on Rails app, and should follow our Rails app conventions.
You can use the GOV.UK Docker environment to run the application and its tests with all the necessary dependencies. Follow the usage instructions to get started.
Use GOV.UK Docker to run any commands that follow.
Running the test suite
bundle exec rspec
Assets on S3
All assets are uploaded to the S3 bucket via a separate govuk_sidekiq job triggered if virus scanning succeeds. Assets are currently still also saved to the NFS mount as per the original behaviour.
In non-production environments if the AWS_S3_BUCKET_NAME environment variable is not set, then a fake version of S3 (S3Storage::Fake) is used and the other AWS_* environment variables do not need to be set. In this case, files are saved to the local filesystem instead of S3 and are served via an instance of Rack::Files mounted on the appropriate route path prefix.
Manuals and decisions
Check the docs directory for detailed instructions, including API documentation.
Viewing the Sidekiq UI
We have access to the Sidekiq UI at the following paths:
This endpoint is authenticated and accessible by adding the 'Sidekiq Admin' permission to your account for Asset Manager in Signon for the relevant environment.
This is only accessible through the
draft-assetshost, as Signon's redirect URI for Asset Manager has been configured to this host, as it is used for serving access restricted draft assets.