siona-DragonX/README.md

# Siona

This is Siona, a maximum privacy block explorer designed for chains which support zaddrs
and which runs <a href="https://explorer.hush.is">explorer.hush.is</a> and <a href="https://explorer.hush.land">explorer.hush.land</a>.

It is written in Perl 5 and generates static HTML with no Javascript and basic inline CSS for styling. It requires a Redis server
running on localhost, which is for caching and reduces disk i/o.

# Installing dependencies
Requires JSON::Any and Redis Perl modules and redis-server an Debian package.

Use Cpan Minus to install Perl Modules:
```sudo apt install cpanminus```

```cpanm JSON::Any``` & ```cpanm Redis```

install jq:
```sudo apt-get install jq```
# Instructions

Assume you put `update.sh` in /home/$USER and your Hush source code in ~/git/hush3 , add this to your $USER crontab with `crontab -e` :

```
# set env vars that Siona will use
SIONA_DOMAIN=explorer.some.poop
SIONA_ACNAME=GAZOOTZ
SIONA_CLI=~/git/hush3/src/hush-cli -ac_NAME=${SIONA_ACNAME}

# update explorer data every 5 minutes
*/5 * * * * ~/update.sh
```

# additional Notes

when running export_env.sh for manual testing, run the script as source. This assigns the env variables to the current shell.

```source ./export_env.sh ``` or ```. ./export_env.sh``` for shorthand

use ```sudo -E``` to preserve env variables if sudo is needed

# Copyright

2016-2023 The Hush Developers

# License

GPLv3