https://github.com/lehigh-university-libraries/ezproxy-url-checker

To proxy or not to proxy? That is the question.
https://github.com/lehigh-university-libraries/ezproxy-url-checker

ezproxy

Last synced: 3 days ago
JSON representation

To proxy or not to proxy? That is the question.

• Host: GitHub
• URL: https://github.com/lehigh-university-libraries/ezproxy-url-checker
• Owner: lehigh-university-libraries
• License: apache-2.0
• Created: 2023-11-02T19:43:53.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-14T21:24:34.000Z (about 1 year ago)
• Last Synced: 2024-06-21T20:06:07.765Z (5 months ago)
• Topics: ezproxy
• Language: Shell
• Homepage:
• Size: 31.3 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ezproxy-url-checker

Check whether a URL exists in your EZproxy config.

## Quickstart

Download the binary from [the latest release](https://github.com/lehigh-university-libraries/ezproxy-url-checker/releases/latest). An automated way to do that might be:

```

./scripts/download-binary.sh

```

Generate the files the service needs from your EZProxy config and start the service

```

./scripts/generate-files.sh /path/to/ezproxy/config.txt/folder

./ezproxy-url-checker

```

See if google scholar is in your EZproxy config

```

curl "http://localhost:8888/proxyUrl?url=https://scholar.google.com"

```

## Deployment

**Coming soon**: instructions on how to get the config files needed for the service from EZProxy onto your system.

### init

To deploy this service to a server, first, you'll need to deploy the binary to your system.

```

$ cd /opt

$ git clone https://github.com/lehigh-university-libraries/ezproxy-url-checker.git

$ cd ezproxy-url-checker

$ ./scripts/download-binary.sh

```

Then you'll need to start the service with your preferred init system.

#### systemd

If you use systemd, you could create a unit file for this service. 

```

$ cat << EOF >/etc/systemd/system/ezproxy-url-checker.service

[Install]

WantedBy=multi-user.target

[Unit]

Description=ezproxy-url-checker

After=network.target

[Service]

WorkingDirectory=/opt/ezproxy-url-checker

Restart=on-failure

RestartSec=30s

ExecStart=/opt/ezproxy-url-checker/ezproxy-url-checker

EOF

$ systemctl enable ezproxy-url-checker.service

$ systemctl start ezproxy-url-checker.service

```

### docker

## TODO

- [x] Integration tests

- [ ] CI/CD instructions

- [ ] Better API Documentation

- [ ] Add docker deployment instructions