Table of Contents
The image service allows any utils service to send files to be publicly hosted. Through an utils interface, such as Directus for example, a user can utils an image and obtain a public URL to use to access their file. The user can either use the original image via a specific URL or process the image through Thumbor for optimization.
The image service (more generally files) consists of a first Nginx server whose configuration contains 3 types of locations:
- /catalog
- /assets/media/*
- /purge/assets/media/*
This first web server is caching resource 1m, then proxy pass to the nginx purge server that contains the same locations but configured with proxy_purge_module. This server caching 30d and can invalidate cache with purge location.
To retrieve an uploaded file, 3 ways :
- /assets/media/original/
image_name.extension: no processing on the image - /assets/media/full/
image_name.extension: transform to webp and serve as webp - /assets/media/optimise/200x0/
image_name.extension: resizing to with 200 and transform to webp and serve as webp
And finally an Express Node API whose roles are:
- providing the list of files exposed by the catalog/reference on a GET route
- uploading new files
- updating existing files
An important point is also the notion of catalog. The catalog serves as a reference & truth for the express API, the image can be accessible on glutton, or in the PV but contains information indicating not to serve it (either it has been deleted from the catalog, or it has expired for example).
To track the images that we have uploaded/deleted/updated we use a Redis server and serve catalog list to json format. Here's a glimpse of it's structure:
[
{
"uuid": "e080a953-5300-427b-bd39-6e235d8238a2",
"version": 1,
"namespace": "DEV",
"public_url": "http://localhost:8080/palpatine/assets/media/full/image/DEV/default.webp",
"unique_name": "/DEV/default.webp",
"filename": "default.webp",
"original_filename": "default.webp",
"base_url": "http://localhost:8080/palpatine/assets/media",
"external_id": null,
"expired": false,
"expiration_date": null,
"information": null,
"original_mimetype": "image/webp",
"mimetype": "image/webp",
"signature": "ca71754acda70e41cb23e465fbb5ecc683186cf779a2bae2cbf290527b1f6671",
"size": 16730
},
{
"uuid": "d26a191f-1087-4169-b6cd-3db96f38ece4",
"version": 1,
"namespace": "DEV",
"public_url": "http://localhost:8080/palpatine/assets/media/full/image/DEV/error.webp",
"unique_name": "/DEV/error.webp",
"filename": "error.webp",
"original_filename": "error.webp",
"base_url": "http://localhost:8080/palpatine/assets/media",
"external_id": null,
"expired": false,
"expiration_date": null,
"information": null,
"original_mimetype": "image/webp",
"mimetype": "image/webp",
"signature": "368ba95afb311edfe0cb7f3b4a221e8b2a3edeb4e16fc5683762791f9619b28a",
"size": 10614
}
]2 daily jobs associated with TADA (Transform And Deliver Assets 🎉):
- a job to synchronize the state of our API in relation to YOUR delegated_storage: if the image is in the catalog, but not in your storage, it deletes the image from the catalog.
- a catalog publication job on your delegated storage: the status of the catalog once a day is published on your storage which allows you to retrieve the most up-to-date list in the event of a new API instance.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
- Get a free API Key at https://example.com
- Clone the repo
git clone https://github.com/github_username/repo_name.git
- Install NPM packages
npm install
- Enter your API in
config.jsconst API_KEY = 'ENTER YOUR API';
- Change git remote url to avoid accidental pushes to base project
git remote set-url origin github_username/repo_name git remote -v # confirm the changes
Use this space to show useful examples of how a project can be used.
For more examples, please refer to the Documentation
- Add Changelog
- Add waza
- Add waza 2
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Maintainer name - [email protected]
Project Link: https://github.com/
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!