improve README structure and installation instructions#6988
improve README structure and installation instructions#6988yharroch wants to merge 8 commits intoLibreSign:mainfrom
Conversation
yharroch
commented
Feb 21, 2026
yharroch
commented
- Add Quick Links and improve section structure
- Document occ libresign:install and libresign:configure:* usage
- Clarify standalone dependencies in appdata directory
- Improve license and security references
- Add Quick Links and improve section structure - Document occ libresign:install and libresign:configure:* usage - Clarify standalone dependencies in appdata directory - Improve license and security references Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
vitormattos
left a comment
vitormattos
left a comment
There was a problem hiding this comment.
This is great! The README needed some love. Thanks for taking the initiative.
I feel that some parts read more like full documentation than a README, and a bit too detailed for this level. Maybe we can keep it more focused on what LibreSign is and its core principles, and move deeper explanations to the documentation repository.
I’ve added a few suggestions in the PR to start the review and show the direction I’m thinking about. Happy to iterate together.
| ## Screenshots | ||
|
|
||
| <p align="center"> | ||
| <img src="img/LibreSign.png" alt="LibreSign interface screenshot" width="900"/> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
There was a problem hiding this comment.
Need to update the screenshot:
|
Thanks for your feedback. I’m happy to help and iterate further. |
Co-authored-by: Vitor Mattos <vitor@php.rio> Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
|
@yharroch, you can ask about any doubts in the comments regarding what I discussed that you didn’t understand. |
deletion of useless technical information Co-authored-by: Vitor Mattos <vitor@php.rio> Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
update link's title for contribution Co-authored-by: Vitor Mattos <vitor@php.rio> Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
Deletion of useless license's section Co-authored-by: Vitor Mattos <vitor@php.rio> Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
deletion of useless line Co-authored-by: Vitor Mattos <vitor@php.rio> Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
Adding application's descriptions about some features Co-authored-by: Vitor Mattos <vitor@php.rio> Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
fixing link Co-authored-by: Vitor Mattos <vitor@php.rio> Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
|
Hi @vitormattos I'll tried to work again on the documentation in the right repository during next weeks |
|
Hi, I will review again the newest version. |
vitormattos
left a comment
vitormattos
left a comment
There was a problem hiding this comment.
I made some more comments after last changes. Could you join into a new turn and check again? What do you think about the direction that we are going now with last changes?
| - 🔧 Administrators (installation, configuration, certificates) | ||
| - 👥 Users (how to request and sign documents) | ||
| - 🧪 Developers (architecture and API) | ||
|
|
||
| 👉 https://github.com/LibreSign/documentation |
There was a problem hiding this comment.
The follow suggestion will reduce a bit more:
| - 🔧 Administrators (installation, configuration, certificates) | |
| - 👥 Users (how to request and sign documents) | |
| - 🧪 Developers (architecture and API) | |
| 👉 https://github.com/LibreSign/documentation | |
| - [🔧 Administrators](https://docs.libresign.coop/admin_manual/): installation, configuration, certificates | |
| - [👥 Users](https://docs.libresign.coop/user_manual/): how to request and sign documents | |
| - [🧪 Developers](https://docs.libresign.coop/developer_manual/): architecture, how to contribute and API |
| ### 1️⃣ Install dependencies | ||
| Run the following command as your web server user: | ||
| `occ libresign:install --java --pdftk --jsignpdf` | ||
|
|
||
| This will install: | ||
| - Java (standalone JRE) | ||
| - PDFtk | ||
| - JSignPdf | ||
|
|
||
| All binaries are installed inside the Nextcloud `data/appdata_*/libresign` directory. | ||
| No system-wide installation is required. | ||
|
|
||
| ### 2️⃣ Verify installation | ||
| `sudo -u www-data php /path/to/nextcloud/occ libresign:configure:check` | ||
|
|
||
| This command verifies: | ||
| - Java availability | ||
| - PDFtk setup | ||
| - JSignPdf setup | ||
| - OpenSSL configuration | ||
| - Certificate environment | ||
|
|
||
| ### 3️⃣ Configure root certificate | ||
| You can generate a certificate using OpenSSL or CFSSL. | ||
|
|
||
| Example using OpenSSL: | ||
| `sudo -u www-data php /path/to/nextcloud/occ libresign:configure:openssl --cn="Your Organization - Digital Signature" --o="Your Organization" --c="FR" --st="Region" --l="City"` | ||
|
|
||
| Certificates are generated and stored inside the Nextcloud data directory: `nextcloud_data_dir/appdata_*/libresign` | ||
|
|
||
| No additional server-level configuration is required. |
There was a problem hiding this comment.
I suggest to remove from here and move those steps to https://docs.libresign.coop/admin_manual/, too long to stay here at README. At the docs page would be good to split between automatic (using interface) and handmade setup (with commands).
2 participants
