https://github.com/strukturag/pdfdraw

Nextcloud app to annotate PDF documents
https://github.com/strukturag/pdfdraw

app javascript nextcloud node pdf socket-io socketio

Last synced: about 1 month ago
JSON representation

Nextcloud app to annotate PDF documents

• Host: GitHub
• URL: https://github.com/strukturag/pdfdraw
• Owner: strukturag
• License: agpl-3.0
• Created: 2020-11-25T14:34:09.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-22T10:24:03.000Z (8 months ago)
• Last Synced: 2024-04-22T11:36:15.583Z (8 months ago)
• Topics: app, javascript, nextcloud, node, pdf, socket-io, socketio
• Language: JavaScript
• Homepage:
• Size: 3.17 MB
• Stars: 43
• Watchers: 6
• Forks: 10
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PDF Annotations for Nextcloud

## Installation

- Clone the repository to the `apps` folder of Nextcloud. Make sure to clone

  recursively with submodules or run `git submodule update --init` afterwards

  to fetch third-party components.

- Execute `make` in the checkout folder to fetch other third-party dependencies.

## Server

The backend server is located in the `server` subfolder, see the `README.md`

there for further information.

## Nginx configuration

Add the following to the nginx server configuration so the `pdfdraw` server

runs behind nginx, utilizing the same SSL settings:

    upstream pdfdraw {

        server 127.0.0.1:8080;

    }

    server {

        ... other configuration for Nextcloud ...

        location /socket.io {

            proxy_pass http://pdfdraw/socket.io;

            proxy_http_version 1.1;

            proxy_set_header Upgrade $http_upgrade;

            proxy_set_header Connection "Upgrade";

            proxy_set_header Host $host;

            proxy_set_header X-Real-IP $remote_addr;

            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

        }

        location /download/ {

            proxy_pass http://pdfdraw/download/;

            proxy_http_version 1.1;

            proxy_set_header Host $host;

            proxy_set_header X-Real-IP $remote_addr;

            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

        }

    }

## Nextcloud configuration

The server address and shared secret can be configured in the Nextcloud admin

settings in section `PDF Annotations`.

## Events

Other apps can override the name that is shown in the list of users currently

annotating a document.

For that the app dispatches an event `OCA\PdfDraw::getDisplayName`. The event

has an argument `displayName` which contains the default display name. Logged

in Nextcloud users will use their display name. All other (anonymous) users

will use an empty name by default (this is shown as `Anonymous` in the list).

Event handlers can listen for the `OCA\PdfDraw::getDisplayName` event and update

the `displayName` argument if they can identify the user by other means.

## Translations

Translations to other languages are done in Transifex at

https://www.transifex.com/strukturag/pdfdraw/