Temporary release critical doc Update Status
This is a temporary doc page while the doc is corrected for the v.10 Gold release
Please check status here and check for errors on the pages mentioned. Getting everything corrected won't happen --see Sisyphus -- but the aim is to have error-free Installation, Update and Management pages. This could go to Bugzilla if preferred, the idea was not to clog Bugzilla up with minor doc issues. Anything critical that could cause breakage should go to Bugzilla to be tracked.
- Anyone error-checking: please add notes directly under Chapters and Notes of errors sections.
- General Note: there's a lot of good content in Language-specific version of the manuals that could perhaps usefully be imported into the English manual
Status
Administration Manual
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual
Chapter 1
[https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter1]
UPDATED FOR 10
Believed good.
Notes of errors:
- Needs image updates
"Koozali SME Server 10 is an RPM-based distribution that uses many packages from CentOS and RepoForge" OK
Repoforge deprecated, we use Centos, Epel, Remi-safe and OpenFusion OK
History we might want to add SME 7.0 SME 8.0 and SME 9.0 release date for completeness.... there is like a hole- "
USB printer support - It is now possible to connect the SME Server to a printer via the USB port."=> "USB printer support" "Improved Macintosh file sharing support - The server now includes better support for Macintosh file sharing and eliminates some previous cases where Macintosh users were unable to access i-bays." => remove ? DONEmore globally in the last section remove the "is now " formulation as most of those changes datesadd an entry "limited need of reboot with dedicated events on installation and update of key components"encryption corresponding to the industry standard of 2021
Chapter 2
[https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter2]
Believed good.
Notes of errors:
none known
Chapter 3
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter3
Believed good.
==> need removing Dynamic DNS Service
Notes of errors:
Could use further updates re modern connectivity
Dynamic DNS Service has been deprecated, should refer to smeserver-dyndns contrib if needed
Chapter 4
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter4
UPDATED FOR 10
Believed good.
Notes of errors:
remove PPTP referenceslow requirement should state 4GB of memory unless you disable clamav and antivirus uses, as it needs 1.8GB for its db in memoryremove box for compatibility rhel 5 and rhel 6 references as well as sme 8 and 9RAM 768 MB to install, 2048 MB to effectively run all services including Clam AV, more memory is better. => "
RAM 2048 MB to install and running disabling Clam AV, 4096 MB to effectively run all services including Clam AV, more memory is better. "
Hard Drive Configuration : add a warning that using the default configuration from the text of GUI installer will override the SME defined at boot configuration for RAID.
A reboot will be necessary to reimplement the configuration before starting the installation
Chapter 5
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter5
UPDATED FOR 10
Believed good.
Notes of errors:
- Images from configuring onwards are from old versions, need updating for 10 but not believed wrong
DynDNS has been removed from core, please remove related sections- PPoE not documented (is documented in German and French manuals but images in same language need for English etc.) => to add please
- resize the boot image /trim the borders if not too much work otherwise for later
Chapter 6
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter6
Believed good.
Notes of errors:
- Needs more image updates
Chapter 7
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter7
Believed good.
Notes of errors:
- Needs image updates, linked Win 10 SMB support OOD?
Chapter 8
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter8
Believed good.
Notes of errors:
- Needs image update
Chapter 9
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter9
Believed good.
Notes of errors:
- Needs image updates
Chapter 10
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter10
Believed good.
Notes of errors:
- Needs image updates and text verification
Chapter 11
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter11
Believed good.
Notes of errors:
- Needs image updates
PPTP has been removed, entry is now renamedVPN, but has still to be integrated to current vpn contribsWhy no SFTP => SFTP is part of SSH , and SCP aswellplease docuemnt FTP is now FTPs by default or FTP over TLS, and is forced. IF for any reason you want to be less secure than that check the wiki on how to do so (need documenting in the faq too see https://forums.contribs.org/index.php/topic,54454.0.html
Chapter 12
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter12
Believed good.
Notes of errors:
- Needs image updates
remove Create Starter Web Site; deprecated- add section on report bug panel
Chapter 13
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter13
Believed good.
Notes of errors:
- Needs image updates
Chapter 14
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter14
Believed good.
Notes of errors:
- Needs image updates for SME 10 and Win 10
Appendix
https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Appendix
Believed good.
Notes of errors:
- DYN DNS needs checks and extensions ==dropped, please remove; just state that if you do not have static ip , you need to refer the the contrib smeserver-ddclient
Glossary
https://wiki.koozali.org/SME_Server:Documentation:Glossary
Believed good.
Notes of errors:
Perhaps add more modern terms? yesprecise that pptpd is insecure and deprecatedin vpn precise that current protocols are openvpn, ipsec/xl2tpd available as contribs and soon wireguard
User Manual
https://wiki.koozali.org/SME_Server:Documentation:User_Manual
Chapter 1
[https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter1]
UPDATED FOR 10
Believed good.
Notes of errors:
- Needs image updates
Chapter 2
[https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter1]
UPDATED FOR 10
Believed good.
Notes of errors:
- Needs image updates
Chapter 3
[https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter1]
UPDATED FOR 10
Believed good.
Notes of errors:
- Needs image updates
Chapter 4
[https://wiki.koozali.org/SME_Server:Documentation:Administration_Manual:Chapter1]
UPDATED FOR 10
Believed good.
Notes of errors:
- Needs image updates
Developers Manual
https://wiki.koozali.org/SME_Server:Documentation:Developers_Manual
PENDING
Notes of errors:
I (JR) have not made much use of the Developers Manual. However, it looks to me as if a significant rewrite of sections may be called for particularly due to changes in systemd services, service control, monitoring etc etc: https://wiki.koozali.org/SME_Server:Documentation:Developers_Manual:Section2#Process_startup.2C_supervision_and_shutdown
FAQ
https://wiki.koozali.org/SME_Server:Documentation:FAQ
PENDING
Notes of errors:
- Much of this relates to OOD solutions for OOD problems, how much to keep?
- Boot options spectacularly so for 10
- logfile https://wiki.koozali.org/SME_Server:Documentation:FAQ:Section03
- need to introduce journalctl eg: myslq.init
- need to reflect changes in services that are not supervised by daemontool /runit anymore (filename change , format change : current => logname.log..)
- mysql
move to mariadb- !!adjusted, need to know if rest of MySQL doc OK
- new templates with more already handled settings
MySQL
https://wiki.koozali.org/MySQL
PENDING
Notes of errors:
- Notes re: MariaDB added, body text needs check for validity of exisiting MySQL notes for v.10
Qpsmtpd:dkim
https://wiki.koozali.org/Qpsmtpd:dkim
PENDING
Notes of errors: