smallsolar
/
libkiwix
mirror of https://github.com/kiwix/libkiwix.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation for static files

This commit is contained in:
Emmanuel Engelhart 2022-09-11 15:36:36 +02:00
parent e1847cb058
commit ee3514d2d6
No known key found for this signature in database
GPG Key ID: 120B30D020B553D3
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -101,6 +101,29 @@ meson . build -Dwrapper=android -Dwerror=false
ninja -C build
```
Static files compilation
------------------------
Libkiwix has a few static files 'compiled' within the binary
code. This is mostly Javascript/HTML/pictures necessary for the HTTP
daemon.
These static files are available in the `static` directory and are
compiled by custom Python code available in this repository `scripts`
directory. This happens automatically at compilation time without any
additional command to run.
To avoid HTTP caching issue, the URLs (to the static content) are
appended with a `cacheid` parameter (this is called "cache
busting"). This `cacheid` value derived from the SHA1SUM of each
targeted static file. As a consequence, each time you change a static
file, the corresponding `cacheid` value will change. To properly test
this feature, this `cacheid` needs to be added manually to the
automated test and has to be commited. To know what are the expected
`cacheid` values, you can build once the libkiwix and then run `grep
-r cacheid build/static/`. Finally update `test/server.cpp` with the
appropriate `cacheid` values which have changed.
Testing
-------