Skip to content

setup.rst

Latest commit

 

History

History
116 lines (81 loc) · 3.91 KB

setup.rst

File metadata and controls

116 lines (81 loc) · 3.91 KB

Setup

Note

If the project does not have an issue for what you want to work on, please create one first.

If you would like to start contributing code, you may wish to begin with our list of good first issues. See the respective sections below for further instructions.

Prerequisites

PHP

  • The PHP version must match the minimum required by the current Nextcloud master branch.
  • You can verify this in the composer.json of the Nextcloud server: Nextcloud Server composer.json (see the config.platform.php entry).
  • At the time of writing this documentation, the minimum required version is 8.1.
  • Docker image suggestion: php-fpm

Node.js

  • The Node.js version must match the engine required by the current Nextcloud master branch.
  • You can verify this in the package.json of the Nextcloud server: Nextcloud Server package.json (see the engines.node entry).
  • At the time of writing this documentation, the required version is ^22.0.0 (with npm ^10.5.0).

Additional dependencies

  • poppler-utils
  • System locale configured with UTF-8 charset

Setting up Nextcloud

This project depends on Nextcloud. To start writing code, you need a working Nextcloud environment. We recommend using Docker, but you may use another method if you prefer.

Suggested setups:

Note

If you encounter problems with these setups, please open an issue in the corresponding repository.

After running the Docker setup, check if Nextcloud is available at http://localhost. If it is not, run docker ps and look for the nextcloud container (or ghcr.io/juliushaertl/nextcloud-dev-php**). If you cannot find it, the setup likely failed; please repeat the previous step.

Once Nextcloud is running, go to the setup folder and locate volumes/nextcloud/apps-extra. Clone the LibreSign repository into this folder .

git clone https://github.com/LibreCodeCoop/libresign.git
cd libresign
git submodule update --init

Open a bash session in the Nextcloud container:

docker compose exec nextcloud bash

Inside the container, go to apps-extra/libresign and run:

# Download composer dependencies
composer install

# Download JS dependencies
npm ci

# Build and watch JS changes
npm run watch

Configuring LibreSign

After setting up the environment and installing LibreSign, open Administration Settings > LibreSign in Nextcloud and:

  • Click the Download binaries button.
  • Once all items show status successful (except “root certificate not configured”), continue to the next section to configure the root certificate.

Extra apps

LibreSign also integrates with the following Nextcloud apps:

App Description
guests Allows inviting guest users to sign documents.
notifications Sends notifications about signature requests and updates.
activity Logs activities such as signature requests and confirmations.
viewer Enables PDF viewing inside LibreSign without leaving the app.
files_pdfviewer Required in combination with viewer for proper PDF rendering.