srg-ics-uplb/srg-tr-searcher

Technical Reports Search Engine

SRG Technical Reports Searcher

Useful for setting up a repository of technical reports for a research group.

Credits to: https://github.com/VieVie31/podofo

Dependencies

Must be available on the dev/prod box.

1. Python 3
2. Pip
3. SQLite 3
4. Docker
5. docker-compose

In Ubuntu 20.04: sudo apt install python3-pip sqlite3

Install

(Download the release from the Releases section: https://github.com/srg-ics-uplb/srg-tr-searcher/releases)

1. tar xzvf srg-tr-searcher.tar.gz
2. cd srg-tr-searcher
3. pip install -r requirements.txt
4. export PATH=$PATH:$HOME/.local/bin
5. mkdir app/static/pdf
6. ./reset.sh

Create a client_secret.json with the following variables needed for Google authentication

{
  "web":
  {
    "client_id": "xxx",
    "project_id":"xxx",
    "auth_uri":"xxx",
    "token_uri":"xxx",
    "auth_provider_x509_cert_url":"xxx",
    "client_secret":"xxx",
    "redirect_uris":["http://localhost:5000/callback"]
  }
}

Deploy

Docker is the best way to deploy the app. This assumes that the remote docker host is configured for passwordless access.

1. Set a strong username and password in app/creds.py
2. Disable upload by setting app.config['ALLOW_UPLOAD'] = False in app/__init__.py
3. DOCKER_HOST="ssh://remote.docker.host" docker-compose down
4. DOCKER_HOST="ssh://remote.docker.host" docker-compose build
5. DOCKER_HOST="ssh://remote.docker.host" docker-compose up -d

Monitor

1. Get a shell: DOCKER_HOST="ssh://remote.docker.host" docker-compose exec flask bash
2. Download access log: DOCKER_HOST="ssh://remote.docker.host" docker cp srg-tr-searcher:/usr/src/access.log access_for_stats.log
3. Get some stats: ./stats.sh

Upgrading

Do the install for the new version. If there are no changes in the db schema, copy the previous version's app/sql/users.db, app/sql/pdf.db, and app/static/pdf to the new version

Pull Requests

Contributions can be done using pull requests to the dev branch. The pull request has to be reviewed and tested first. Each pull request should address a maximum of 5 issues/features.

git fetch pull/PRNUMBER/head:BRANCHNAME
git checkout BRANCHNAME

Test the BRANCHNAME. Accept the pull request if everything is ok.

srg-tr-searcher's Issues

Show the titles of the three latest additions to the repository

Add "RESEARCH_GROUP_NAME" config in creds.py

This will be used in the copyright footer

(c) $RESEARCH_GROUP_NAME powered by SRG-ICS-UPLB

Show number of users who 'favorited' a paper in search results

Update dev branch to reflect the changes in prod

Show full abstract if available

Enable search without logging in

This feature will allow users to search for reports and view title, authors, abstracts, and bibtex only. Only logged in users can view the full report.

Add to favorities not working consistently

Add email as watermark to downloaded PDF

This can be incorporated in the QR code or separately printed on the sides of the paper

Sanitize request parameters

Fix the accuracy of stats.sh

Enable editing of entries for admin users

Allow title of paper to wrap

Update README

Only use abstract for search

Currently the entire PDF is converted to text. This text is used for search. To speed up upload, use just the abstract. This will require altering the schema and adding an abstract field.

Provide command line tool to batch upload and download

For admin convenience