24eme/signaturepdf
24eme/signaturepdf
1
0
Fork 0
mirror of https://github.com/24eme/signaturepdf.git synced 2023-08-25 09:33:08 +02:00
Code Issues Releases Wiki Activity

Reorganization of documentation

Browse Source
This commit is contained in:
Vincent LAURENT 2022-07-18 21:14:57 +02:00
parent 8d25b8cafa
commit e5dd867883
1 changed files with 42 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
README.md
View File

@ -16,6 +16,7 @@ Logiciel libre sous license AGPL V3
## Installation ## Installation
### Debian/Ubuntu ### Debian/Ubuntu
Dépendances : Dépendances :
- php >= 5.6 - php >= 5.6
@ -24,7 +25,7 @@ Dépendances :
- imagemagick - imagemagick
- potrace - potrace
Sur debian : Installation des dépendances :
``` ```
sudo aptitude install php librsvg2-bin pdftk imagemagick potrace sudo aptitude install php librsvg2-bin pdftk imagemagick potrace
@ -42,7 +43,7 @@ Pour le lancer :
php -S localhost:8000 -t public php -S localhost:8000 -t public
``` ```
### Configuration de PHP #### Configuration de PHP
``` ```
upload_max_filesize = 24M # Taille maximum du fichier PDF à signer upload_max_filesize = 24M # Taille maximum du fichier PDF à signer
@ -50,7 +51,7 @@ post_max_size = 24M # Taille maximum du fichier PDF à signer
max_file_uploads = 201 # Nombre de pages maximum du PDF, ici 200 pages + le PDF d'origine max_file_uploads = 201 # Nombre de pages maximum du PDF, ici 200 pages + le PDF d'origine
``` ```
### Déployer avec apache #### Configuration d'apache
``` ```
DocumentRoot /path/to/signaturepdf/public DocumentRoot /path/to/signaturepdf/public
@ -64,6 +65,38 @@ DocumentRoot /path/to/signaturepdf/public
</Directory> </Directory>
``` ```
### Déployer avec docker
#### Construction de l'image
```bash
docker build -t signaturepdf .
````
#### Lancement d'un conteneur
```bash
docker run -d --name=signaturepdf -p 8080:80 signaturepdf
````
[localhost:8080](http://localhost:8080)
#### Configuration
Les variables suivantes permettent de configurer le déployement :
|Variable|description|exemple|defaut|
|-----|-----|-----|-----|
|`SERVERNAME`|url de déploiement|`pdf.24eme.fr`|localhost|
|`UPLOAD_MAX_FILESIZE`|Taille maximum du fichier PDF à signer|48M|24M|
|`POST_MAX_SIZE`|Taille maximum du fichier PDF à signer|48M|24M|
|`MAX_FILE_UPLOADS`|Nombre de pages maximum du PDF, ici 200 pages + le PDF d'origine|401|201|
|`PDF_STORAGE_PATH`|chemin vers lequel les fichiers pdf uploadés pourront être stockés|/data||
```bash
docker run -d --name=signaturepdf -p 8080:80 -e SERVERNAME=pdf.example.org -e UPLOAD_MAX_FILESIZE=48M -e POST_MAX_SIZE=48M -e MAX_FILE_UPLOADS=401 -e PDF_STORAGE_PATH=/data signaturepdf
````
### Alpine ### Alpine
Voici un script permettant d'installer la solution sous Linux Alpine (testé en version 3.15). Voici un script permettant d'installer la solution sous Linux Alpine (testé en version 3.15).
@ -169,13 +202,7 @@ PDF_STORAGE_PATH=/var/www/signaturepdf/tmp
EOF EOF
``` ```
### Mise à jour vers la dernière version ## Configuration
La dernière version stable est sur la branche `master`, pour la mise à jour il suffit de récupérer les dernières modifications :
```
git pull -r
```
### Activation et configuration du mode partage de signature à plusieurs ### Activation et configuration du mode partage de signature à plusieurs
@ -206,37 +233,13 @@ Par exemple pour apache :
chown www-data /path/to/folder/to/store/pdf chown www-data /path/to/folder/to/store/pdf
``` ```
### Déployer avec docker ## Mise à jour
#### Construction de l'image La dernière version stable est sur la branche `master`, pour la mise à jour il suffit de récupérer les dernières modifications :
```bash ```
docker build -t signaturepdf . git pull -r
```` ```
#### Lancement d'un conteneur
```bash
docker run -d --name=signaturepdf -p 8080:80 signaturepdf
````
[localhost:8080](http://localhost:8080)
#### Configuration
Les variables suivantes permettent de configurer le déployement :
|Variable|description|exemple|defaut|
|-----|-----|-----|-----|
|`SERVERNAME`|url de déploiement|`pdf.24eme.fr`|localhost|
|`UPLOAD_MAX_FILESIZE`|Taille maximum du fichier PDF à signer|48M|24M|
|`POST_MAX_SIZE`|Taille maximum du fichier PDF à signer|48M|24M|
|`MAX_FILE_UPLOADS`|Nombre de pages maximum du PDF, ici 200 pages + le PDF d'origine|401|201|
|`PDF_STORAGE_PATH`|chemin vers lequel les fichiers pdf uploadés pourront être stockés|/data||
```bash
docker run -d --name=signaturepdf -p 8080:80 -e SERVERNAME=pdf.example.org -e UPLOAD_MAX_FILESIZE=48M -e POST_MAX_SIZE=48M -e MAX_FILE_UPLOADS=401 -e PDF_STORAGE_PATH=/data signaturepdf
````
## Tests ## Tests