Skip to content

Commit 139e415

Browse files
Apply suggestions from code review
Co-authored-by: Florent <[email protected]>
1 parent 681bc3a commit 139e415

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

submissions/yunohosters/README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Docs for Yunohost.
77

88
YunoHost is an Debian-based operating system aiming at simplifying server administration and therefore democratize self-hosting while making sure it stays reliable, secure, ethical and lightweight. It is a copyleft libre software project maintained exclusively by volunteers, who have been packaging in a 600+ apps store in the course of 13 years.
99

10-
Packaging Docs on YunoHost allows for individual interested in the product to easily deploy and it for their association / personal use.
10+
Packaging Docs on YunoHost allows for individuals and small organizations interested in the product to easily deploy with the least technical knowledge required.
1111

1212
[More on Yunohost](https://doc.yunohost.org/admin/what_is_yunohost/)
1313

@@ -24,6 +24,7 @@ We'll add a video tomorrow.
2424
## Key Achievements
2525

2626
Install script done. You can now self-host Docs in a few click, without having to trouble yourself with sys admin complexity.
27+
We also support attachments, like images.
2728
Fixed Garage's Yunohost package. Garage is a S3 storage alternative, that might be a good replacement of MiniO after recent changes of policy.
2829

2930
## Challenges Overcome
@@ -34,11 +35,11 @@ Docs is usually installed using docker but Yunohost is about rebuilding from sou
3435

3536
***Which version of Python3.12 ?**
3637

37-
Docs runs on Python 3.12, a relatively recent version of Python which is still not shipped in recent Debian versions. Thus, many Yunohost installs won't have native Python 3.12. This caused us a few hesistations. Should we add a ppa to an additional source or recompile Python 3.12 ? In the end, we decided to patch Docs's code (which is very easily done with Yunohost system) to lower requirements to Python 3.11, hoping that no breaking changes happened between 3.11 and 3.12.
38+
Docs runs on Python 3.12, a relatively recent version of Python which is still not shipped in Debian Bookworm (it should be available in [Trixie](https://packages.debian.org/trixie/python3.13)). Thus, many Yunohost installs won't have native Python 3.12. This caused us a few hesistations. Should we add a ppa to an additional source or recompile Python 3.12 ? In the end, we decided to patch Docs's code (which is very easily done with Yunohost system) to lower requirements to Python 3.11, hoping that no breaking changes happened between 3.11 and 3.12.
3839

3940
**Authentication**
4041

41-
Docs expects a OIDC and Yunohost's auth system is currently based on LDAP. Waiting for future Yunohost version, which will include native-OIDC auth, we used Dex in the meantime.
42+
Docs expects an OIDC identity provider and Yunohost's auth system is currently based on LDAP. We are waiting for a future Yunohost version that would implement an OIDC identity provider natively ([issue](https://github.com/YunoHost/issues/issues/676)). In the meantime, we take advantage of [the Dex package for Yunohost](https://github.com/YunoHost-Apps/dex_ynh) to allow LDAP users authenticate through an OIDC flow.
4243

4344
**S3 storage**
4445

@@ -52,6 +53,13 @@ With the recent change of policy from Minio, we decided to work on making our pa
5253
Self-hosting and the creation of community is a big stake of all open-source apps - including for La Suite. By allowing smaller structures and individuals to self-host, Yunohost might be a good way to build community around La Suite's apps and turn this public code into small but real uses.
5354

5455
## Next Steps
56+
- Choose a LICENCE
57+
- Support other operations: remove, upgrade, backup, restore, change-url
58+
- Add configurations option?
59+
- Cleanup
60+
- Add documentation for the admins?
61+
- Add Docs to the Yunohost's apps catalog so it is publicly available
62+
- Connect docs with the server's SMTP service to send email
5563
- Maintenance of the package overtime
5664
- Change OIDC to work with Authelia
5765
- Watch compatibility between Python3.12 and Python3.11

0 commit comments

Comments
 (0)