mirror of
https://github.com/YGGverse/flarumdown.git
synced 2026-03-31 16:55:29 +00:00
69 lines
No EOL
2.3 KiB
Markdown
69 lines
No EOL
2.3 KiB
Markdown
# flarumdown
|
|
|
|
|
|
[](https://deps.rs/repo/github/YGGverse/flarumdown)
|
|
[](https://crates.io/crates/flarumdown)
|
|
|
|
Flarum is down - read in Markdown
|
|
|
|
CLI tool for [Flarum](https://flarum.org) v2 that allows to export public DB entries into Markdown format.
|
|
|
|
> [!IMPORTANT]
|
|
> This extension was created by and for the UANA community forums. This means that it's adapted for our local build first:
|
|
> * SQLite driver is in use
|
|
> * FoF/upload plugin installed
|
|
> * Markdown (only) plugin is enabled
|
|
> * Flarum v2 (7 beta)
|
|
|
|
## Install
|
|
|
|
``` bash
|
|
cargo install flarumdown
|
|
```
|
|
|
|
## Usage
|
|
|
|
``` bash
|
|
RUST_LOG=trace flarumdown -s '/path/to/flarum.sqlite' \
|
|
-t '/path/to/target' \
|
|
-p '/path/to/public' \
|
|
-i index \
|
|
-r http://[202:68d0:f0d5:b88d:1d1a:555e:2f6b:3148] \
|
|
-r http://[505:6847:c778:61a1:5c6d:e802:d291:8191] \
|
|
-r http://hc3fycfadz7fkapp62fqi6llioe46fvis6wuswfobl5ghc2u7snq.b32.i2p \
|
|
-r http://w6vtcpbir5vvokwdqqbqlrdtnzwyfc4iyqn6owxuyjeppszuydutqwqd.onion
|
|
```
|
|
|
|
### Crontab
|
|
|
|
``` bash
|
|
$ crontab -u www-data -e
|
|
@weekly /var/www/flarum/flarumdown.sh > /dev/null 2>&1
|
|
```
|
|
|
|
``` flarumdown.sh
|
|
#!/bin/bash
|
|
|
|
RUST_LOG=warn NO_COLOR=1 /usr/local/bin/flarumdown \
|
|
-s /var/www/flarum/flarum.sqlite \
|
|
-t /var/www/flarum/public/flarumdown/dump \
|
|
-p /var/www/flarum/public \
|
|
-i index \
|
|
-r http://[202:68d0:f0d5:b88d:1d1a:555e:2f6b:3148] \
|
|
-r http://[505:6847:c778:61a1:5c6d:e802:d291:8191] \
|
|
-r http://hc3fycfadz7fkapp62fqi6llioe46fvis6wuswfobl5ghc2u7snq.b32.i2p \
|
|
-r http://w6vtcpbir5vvokwdqqbqlrdtnzwyfc4iyqn6owxuyjeppszuydutqwqd.onion
|
|
|
|
# create .zip file to simply download for offline reading
|
|
readonly TARGET_DUMP_D=/var/www/flarum/public/flarumdown/dump
|
|
|
|
cd -P "$TARGET_DUMP_D" || { echo "Could not cd to $TARGET_DUMP_D"; exit 1; }
|
|
|
|
if [[ ! "$PWD" -ef "$TARGET_DUMP_D" ]]; then
|
|
echo "Unexpected path! Current: $PWD, Expected: $TARGET_DUMP_D"
|
|
exit 1
|
|
fi
|
|
|
|
zip -FS -r -9 /var/www/flarum/public/flarumdown/dump.zip .
|
|
chmod 0755 -R "$TARGET_DUMP_D"
|
|
``` |