|
| 1 | +YASGG |
| 2 | +===== |
| 3 | + |
| 4 | +**Yet Another Static Gallery Generator** |
| 5 | + |
| 6 | +## Overview |
| 7 | + |
| 8 | +YASGG is a static gallery generator with optional encryption support written in python. |
| 9 | + |
| 10 | +If a passowrd is chossen, the gallery generator encrypts the images with AES 256 bit. |
| 11 | +On the browser side the decryption process is done by the chossen password in JavaScript. |
| 12 | +As encrypted you can upload your gallery to any service that delivers static content like GitHub Pages, Amazon S3, |
| 13 | +Dropbox, Google Drive and so on with no privacy concerns. |
| 14 | + |
| 15 | +## Demo |
| 16 | + |
| 17 | +* Link: http://github.io/nomnomnom/yasgg-demo/ |
| 18 | +* Password: 21f3a7f6373ccb42631b5671db4f5a5a60aed6dedf8e7b71d27e55288f41f6dc |
| 19 | + |
| 20 | +## Features |
| 21 | + |
| 22 | +* encryption (client side decryption of photos) |
| 23 | +* responsive default theme |
| 24 | +* themeable |
| 25 | + |
| 26 | +## Installation |
| 27 | + |
| 28 | +### PyPI |
| 29 | + |
| 30 | + pip install yasgg |
| 31 | + yasggctl -h |
| 32 | + |
| 33 | +### Prebuilt binaries |
| 34 | + |
| 35 | +### From source |
| 36 | + |
| 37 | + git clone [email protected]:nomnomnom/yasgg.git |
| 38 | + cd yasgg |
| 39 | + pip install -r requirements.txt |
| 40 | + yasgg/bin/yasggctl -h |
| 41 | + |
| 42 | +## Example |
| 43 | + |
| 44 | + yasggctl build --recrusive 1 --photos-import-dir /tmp/photos_dir_2_import --album-name "YASGG demo album" -p 21f3a7f6373ccb42631b5671db4f5a5a60aed6dedf8e7b71d27e55288f41f6dc |
| 45 | + cd yasgg_demo_album |
| 46 | + yasggctl serve |
| 47 | + |
| 48 | +## Usage |
| 49 | + |
| 50 | + Usage: yasggctl build -n <album-name> -i <photos-import-dir> [-t <theme>] [-p <password>] [-r <recrusive>] |
| 51 | + yasggctl serve [-o <port>] [-b <bind>] |
| 52 | + yasggctl [-h] [-v] |
| 53 | + |
| 54 | + |
| 55 | + Build command: |
| 56 | + Creates a new album. |
| 57 | + Example: yasggctl build --recrusive 1 --photos-import-dir ./tests/sample --album-name "foo bar" --theme default |
| 58 | + |
| 59 | + -n <ablum-name>, --album-name <album-name> Name of the new album. |
| 60 | + -i <photos-import-dir>, --photos-import-dir <photos-import-dir> Directory of photos to import. |
| 61 | + -p <password>, --password <password> Use encryption of images. Use a _STRONG_ password! |
| 62 | + -r {0,1}, --recrusive Search recrusive for photos into --photos-import-dir [default: 0] |
| 63 | + -t {default, galleria_classic}, --theme The theme to use. [default: default] |
| 64 | + |
| 65 | + |
| 66 | + Serve command: |
| 67 | + Serves a created album. |
| 68 | + Example: yasggctl serve -o 9000 -b 0.0.0.0 |
| 69 | + |
| 70 | + -o <port>, --port <port> Name of the new album. [default: 9000] |
| 71 | + -b <bind>, --bind <bind> Address to run the test server on [default: 127.0.0.1] |
| 72 | + |
| 73 | + |
| 74 | + Global options: |
| 75 | + -h, --help Show this help message and exit. |
| 76 | + -v, --version Show program's version number and exit. |
| 77 | + |
| 78 | +## License |
| 79 | +[Beerware](https://raw.github.com/nomnomnom/yasgg/master/LICENSE) |
| 80 | + |
| 81 | +## Contact |
| 82 | +nomnomnom [at] secure-mail.cc |
| 83 | + |
| 84 | +--- |
| 85 | +Enjoy! |
0 commit comments