github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/examples/kiwix/README.md (about)

     1  import ExampleYAML from "@site/src/components/ExampleYAML";
     2  
     3  # Data Injections (Kiwix)
     4  
     5  This example shows Jackal's ability to inject data into a container running in a pod, in this case to initialize a [Kiwix server](https://www.kiwix.org/en/) to allow offline viewing of documentation and wiki pages.
     6  
     7  
     8  Data injections allow for data that is not included in the container image to be injected at deploy time and are declared using the `dataInjections` key within a component.  Once the specified container is started, Jackal will copy the files and folders from the specified source into the specified container and path.
     9  
    10  :::caution
    11  
    12  Data injections depend on the `tar` (and for `compress`, `gzip`) executables and their implementation across operating systems.  Between macOS and Linux there is general agreement on how these utilities should function, however on Windows you may see issues enabling compression.
    13  
    14  To resolve this you can either disable compression or use the GNU core-utils version of `tar` and `gzip`.
    15  
    16  :::
    17  
    18  ## `jackal.yaml` {#jackal.yaml}
    19  
    20  :::info
    21  
    22  To view the example in its entirety, select the `Edit this page` link below the article and select the parent folder.
    23  
    24  :::
    25  
    26  <ExampleYAML src={require('./jackal.yaml')} showLink={false} />