node-lightgallery

Node JS simple implementation for Lightgallery with simple access token management (user interface for managing tokens).

Uses lightgallery (https://github.com/sachinchoolur/lightGallery) for frontend photo management.

Getting started

Requirements:

• Node.js runtime & NPM (Node Package Manager)
• Database server (Currently supported: MySQL)

Setup instructions (Unix)

Start by cloning this repo:

git clone https://github.com/sinipelto/node-lightgallery.git ./gallery

Get access to a supported database or (Optional) Install and configure a database system from a supported db provider to a local system (e.g. for local testing).

Ensure that you have access to a database (User and password, DB, a Table with CRUD permissions).

Go to the repository directory:

cd ./gallery

Install required dependencies:

npm i

or

npm install

Configure the environment variables to match your environment:

cp .env.example .env
nano .env

To start right off, just launch the: server.js:

node server.js

( OR with NPM:

npm start

)

(Optional) Create a service for the application to ensure its running and to get proper logging/journaling:

Create a systemd daemon service for the node application:

nano node-gallery.service

Write and Modify the following to match with your environment, OS etc.:

[Unit]
Description=Systemd Service Unit for node.js Lightgallery App
After=network.target network-online.target

[Service]
WorkingDirectory=/path/to/gallery
EnvironmentFile=/path/to/gallery/.env
Type=simple
Restart=always
RestartSec=3
User=<USER or nobody>
ExecStart=/usr/bin/env npm start

[Install]
WantedBy=multi-user.target

(USER => e.g. root/user with read access to server and gallery directory)

Install the service:

(sudo / root user)
sudo cp node-gallery.service /etc/systemd/system/node-gallery.service
sudo systemctl daemon-reload

(Optional) Enable the service on system startup:

(sudo / root user)
sudo systemctl enable node-gallery

Finally, start the service:

(sudo / root user)
sudo systemctl start node-gallery

( OR with service CLI:

(sudo / root user)
sudo service node-gallery start

)

Usage instructions

Once you have the server up and running correctly, you can set up the albums.

The directory path for the albums is set in the .env file. Assuming it to be set to /path/to/albums.

Ensure the directory exists:

dir="/path/to/albums"; [ ! -f "$dir" ] && (mkdir "$dir" && echo "Album dir created." || echo "ERROR: Failed to create album directory.") || echo "Album dir already exists."

Now, add an album to the albums directory. E.g. album test-album would be a directory in /path/to/albums/test-album

mkdir /path/to/albums/test-album

Now, add some images/photos to the album directory. The image filename doesn't matter. E.g.:

/path/to/albums/test-album/img1.png /path/to/albums/test-album/img2.png /path/to/albums/test-album/img3.jpg /path/to/albums/test-album/img4.bmp

(Optional but highly recommended) You can also add a meta file to add a title and description for the album:

nano /path/to/albums/test-album/meta.json

With a following format:

{
    "title": "My Test Album",
    "description": "This is my test album. You can start the slideshow by clicking one of the photos."
}

Next, you need to generate a token for the album to access it through the web server.

The initial key for management page is generated on the first successful launch of the server. The key resides in the file tokens.json. Get the token value from the file:

cat tokens.json

[
    {
        "path": "/management",
        "value": "<TOKEN_VALUE>", // EXAMPLE TOKEN
    },
    ...
]

Go to the management page: http(s)://server-url/management?key=<TOKEN_VALUE>.

OR to create the URL programmatically:

echo "http(s)://<YOUR-SERVER-URL>:<PORT>/management?key=$(cat tokens.json | grep "management" -m1 -A1 | tr { '\n' | tr , '\n' | tr } '\n' | grep "value" | awk  -F'"' '{print $4}')"

e.g.

echo "http://127.0.0.1/management?key=$(cat tokens.json | grep "management" -m1 -A1 | tr { '\n' | tr , '\n' | tr } '\n' | grep "value" | awk  -F'"' '{print $4}')"

From the Management page you can manage (create, edit, delete, disable) all of the access tokens (including management and index page keys).

CAUTION: Never delete the last known active key to the /management route or you WILL LOSE ACCESS to the management interface until a new key is manually created into the DB / the db is reset (table deleted).

Next, generate a new token for the just created album (see the 'Create new key' section).

The new album with all the photos included in the album directory is now accessible in: http(s)://server-url/test-album?key=<TOKEN_FOR_THE_ALBUM>.