The current documentation uses [Jekyll](https://jekyllrb.com/docs) as the static site generator. [Docker](https://www.docker.com/) is required to run the project.
# How to run
## How to run
## Jekyll container only
### Jekyll container only
For faster development process, the following command is recommended:
@@ -28,7 +31,7 @@ Or you could use:
docker run --rm--volume="$PWD/htdocs:/srv/jekyll"-p 4000:4000 -it jekyll/jekyll:4.2.0 jekyll serve
```
## Full compose stack (search)
### Full compose stack (search)
Add `edocs.local` to your `/etc/hosts` or customize `NGINX_HOST` in .env as desired.
docker run --rm-v="$PWD/htdocs:/srv"-it ruby:2.7.1 /bin/bash bundle update && mdl *
```
# Deployment
## Deployment
Since this project depends on [ElasticSearch](https://www.elastic.co/), the deployment should follow the recommended approach and configuration as detailed in [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html)
@@ -7,16 +7,21 @@ In some cases, the inactive slot can be unpopulated or contain much older firmwa
To do this, sideload the `copy-partitions-20220613-signed.zip` package by doing the following:
1. Download the `copy-partitions-20220613-signed.zip` file from [here](https://mirrorbits.lineageos.org/tools/copy-partitions-20220613-signed.zip). It should have a MD5 sum of `79f2f860830f023b7030c29bfbea7737` or a SHA-256 sum of `92f03b54dc029e9ca2d68858c14b649974838d73fdb006f9a07a503f2eddd2cd`.
{%- if device.uses_twrp %}
2. Sideload the `copy-partitions-20220613-signed.zip` package:
1. Sideload the `copy-partitions-20220613-signed.zip` package:
* On the device, select `Advanced`, `ADB Sideload`, then swipe to begin sideload
* On the host machine, sideload the package using: `adb sideload copy-partitions-20220613-signed.zip`
{%- else %}
2. Sideload the `copy-partitions-20220613-signed.zip` package:
1. Sideload the `copy-partitions-20220613-signed.zip` package:
* On the device, select `Apply Update`, then `Apply from ADB` to begin sideload.
* On the host machine, sideload the package using: `adb sideload copy-partitions-20220613-signed.zip`
3. Now reboot to recovery by tapping `Advanced`, then `Reboot to recovery`.
1. Now reboot to recovery by tapping `Advanced`, then `Reboot to recovery`.