Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/farynam/nextcloud_link_tracker

Simple cron based monitoring for NextCloud.
https://github.com/farynam/nextcloud_link_tracker

audit auditing database links monitoring nextcloud shares

Last synced: 2 months ago
JSON representation

Simple cron based monitoring for NextCloud.

Host: GitHub
URL: https://github.com/farynam/nextcloud_link_tracker
Owner: farynam
License: mit
Created: 2024-07-09T12:04:49.000Z (6 months ago)
Default Branch: master
Last Pushed: 2024-07-11T13:55:56.000Z (5 months ago)
Last Synced: 2024-09-27T06:04:30.464Z (3 months ago)
Topics: audit, auditing, database, links, monitoring, nextcloud, shares
Language: JavaScript
Homepage:
Size: 17.6 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Next Cloud link tracker
Simple cron based notification for NextCloud.
It uses database directly for queries. Also it saves state in order to narrow notifications results.
Notification is for Nextcloud resources such as:
- calendars
- files
- forms

## Requirements
- docker or podman with podman-compose installed (preffred is podman but you can easily turn it to docker)

## Build
```
$ ./build_image_docker.run
```
or
```
$ ./build_image_podman.run
```

## configuration
Positions with * are optional.
### Setup configuration variables
These are environment variables:
- *VERBOSE - true | false show configuration and state on startup.
- DATA_HOME - directory where to store state file.
- CONFIG_HOME - Directory where to find configuration
- CONFIG_FILE - Configuration file name without path.
- *NODE_EXTRA_CA_CERTS - extra CA for node if any
- CRON_FILE - file with a cron expression like CRON_JOB="*/1 * * * *"

### *Setup env variables for corporate proxy build
```
export HTTP_PROXY="http://"
export HTTPS_PROXY="http://"
export NO_PROXY=""
```

## How to run it
### Without container
It will just notify and exit.
```
$ node i
$ node src/app/index.mjs
```

### Via podman or docker directly
look at run.sh in the project dir.

### Via podman/docker compose
Basically run the script below.

1.Get yourself a SMTP server
2.Configure SMTP in ./volumes/conf/config.json
3.Run
```
$ podman-compose -f podman-compose.yml up
```
2. go to http://localhost:8081 and configure nextcloud
3. Launch some email client and configure
4. Try to update/add calendars, files, forms

## Tested for versions
- Nextcloud Hub 8 (29.0.1)
- podman version 4.3.1
- podman-composer version 1.0.3
- Debian GNU/Linux 12 (it should work on other platforms)

## Notification format

```
Current shares:
{
"calendarShares": [],
"fileShares": [
{
"owner": "resource owner email",
"resource": "resource name",
"link": "link to the resource",
"updated": "resource update time"
}
],
"formShares": []
}
```

## Directories