Difference between revisions of "SME Server:Documentation"

From SME Server
Jump to navigation Jump to search
m
 
(57 intermediate revisions by 11 users not shown)
Line 1: Line 1:
If you'd like to contribute to the manual, please register and start editing, see [[Help:Editing|Editing Help]]
+
{{Languages}}
 +
{{Donate}}
  
'''SME Server Manuals'''
 
  
SME Server Documentation is based around four manuals. See here for [[SME_Server:Documentation:Administration_Manual:Guidelines|descriptions]] of the differences and aims of each.
+
===SME Server Manuals===
  
The [[SME_Server:Documentation:Administration_Manual|Administration Manual]] describes installation and day to day operation by the local Server Admin.<br />
+
There are three main manuals:
The [[SME_Server:Documentation:User_Manual|User Manual]] provides information to help users configure their client applications, and how they can interact with the server.<br />
+
 
The [[SME_Server:Documentation:Technical_Manual|Technical Manual]] aka system tweaking guide, commands and methods to modify the sever and further help.<br />
+
'''[[SME_Server:Documentation:Administration_Manual|The Administration Manual]]'''<br /> Describes installation and day to day operation by the Server Administrator.
The [[SME_Server:Documentation:Developers_Manual|Developers Manual]] contains information required to integrate applications into SME.<br />
+
 
There is also a '[[SME_Server:Documentation:Administration_Manual:FAQ|Frequently Asked Questions]]' and a '[[SME_Server:Documentation:Administration_Manual:HowTo|HowTo]]' Collection.<br />
+
'''[[SME_Server:Documentation:User_Manual|The User Manual]]'''<br />
 +
Provides information to help users configure their client applications, and interact with the server.
 +
 
 +
'''[[SME_Server:Documentation:Developers_Manual|The Developers Manual]]'''<br />
 +
Contains information required to integrate applications into SME.
 +
 
 +
There are also [[SME_Server:Documentation:FAQ|Frequently Asked Questions]], [[:Category:Howto|Howto]], [[:Category:Contrib|Contrib]] Collections, and a [[Temporary release critical doc Update Status]] page -- this will be removed on release of v.10.
  
 
----
 
----
'''[[SME_Server:Documentation:Administration_Manual|Administration Manual]]'''<br />
+
 
[[SME_Server:Documentation:Administration_Manual:Chapter1|Chapter 1. Welcome to SME Server 7.0]]<br />
+
'''[[SME_Server:Documentation:Administration_Manual|Administration Manual : Index page]]'''
 +
 
 +
Direct chapter links:
 +
 
 +
[[SME_Server:Documentation:Administration_Manual:Chapter1|Chapter 1. Welcome to SME Server 10]]<br />
 
[[SME_Server:Documentation:Administration_Manual:Chapter2|Chapter 2. The role of the SME Server]]<br />
 
[[SME_Server:Documentation:Administration_Manual:Chapter2|Chapter 2. The role of the SME Server]]<br />
 
[[SME_Server:Documentation:Administration_Manual:Chapter3|Chapter 3. Your Internet Service Provider (ISP)]]<br />
 
[[SME_Server:Documentation:Administration_Manual:Chapter3|Chapter 3. Your Internet Service Provider (ISP)]]<br />
[[SME_Server:Documentation:Administration_Manual:Chapter4|Chapter 4. Hardware Requirements of the SME Server]]<br />
+
[[SME_Server:Documentation:Administration_Manual:Chapter4|Chapter 4. Hardware requirements of the SME Server]]<br />
[[SME_Server:Documentation:Administration_Manual:Chapter5|Chapter 5. Installing And Configuring Your SME Server Software]]<br />
+
[[SME_Server:Documentation:Administration_Manual:Chapter5|Chapter 5. Installing and configuring your SME Server Software]]<br />
 
[[SME_Server:Documentation:Administration_Manual:Chapter6|Chapter 6. The Server Console]]<br />
 
[[SME_Server:Documentation:Administration_Manual:Chapter6|Chapter 6. The Server Console]]<br />
[[SME_Server:Documentation:Administration_Manual:Chapter7|Chapter 7. Configuring the Computers on Your Network]]<br />
+
[[SME_Server:Documentation:Administration_Manual:Chapter7|Chapter 7. Configuring the computers on your network]]<br />
[[SME_Server:Documentation:Administration_Manual:Chapter8|Chapter 8. On-going Administration using the server manager]]<br />
+
[[SME_Server:Documentation:Administration_Manual:Chapter8|Chapter 8. On-going administration using the server-manager]]<br />
[[SME_Server:Documentation:Administration_Manual:Chapter9|Chapter 9. Collaboration]]<br />
+
[[SME_Server:Documentation:Administration_Manual:Chapter9|Chapter 9. server-manager : Collaboration]]<br />
[[SME_Server:Documentation:Administration_Manual:Chapter10|Chapter 10. Administration]]<br />
+
[[SME_Server:Documentation:Administration_Manual:Chapter10|Chapter 10. server-manager : Administration]]<br />
[[SME_Server:Documentation:Administration_Manual:Chapter11|Chapter 11. Security]]<br />
+
[[SME_Server:Documentation:Administration_Manual:Chapter11|Chapter 11. server-manager : Security]]<br />
[[SME_Server:Documentation:Administration_Manual:Chapter12|Chapter 12. Miscellaneous]]<br />
+
[[SME_Server:Documentation:Administration_Manual:Chapter12|Chapter 12. server-manager : Miscellaneous]]<br />
[[SME_Server:Documentation:Administration_Manual:Chapter13|Chapter 13. Configuration]]<br />
+
[[SME_Server:Documentation:Administration_Manual:Chapter13|Chapter 13. server-manager : Configuration]]<br />
 
[[SME_Server:Documentation:Administration_Manual:Chapter14|Chapter 14. Information Bays (i-bays)]]<br />
 
[[SME_Server:Documentation:Administration_Manual:Chapter14|Chapter 14. Information Bays (i-bays)]]<br />
 
[[SME_Server:Documentation:Administration_Manual:Appendix|SME Manual Appendix]]<br />
 
[[SME_Server:Documentation:Administration_Manual:Appendix|SME Manual Appendix]]<br />
 +
[[SME_Server:Documentation:Glossary  | SME Manual Glossary ]] <br />
  
 
----
 
----
'''[[SME_Server:Documentation:User_Manual|User Manual]]'''<br />
+
'''[[SME_Server:Documentation:User_Manual|User Manual : Index page]]'''
 +
 
 +
Direct chapter links:
 +
 
 
[[SME_Server:Documentation:User_Manual:Chapter1|Chapter 1. Remote Access]]<br />
 
[[SME_Server:Documentation:User_Manual:Chapter1|Chapter 1. Remote Access]]<br />
[[SME_Server:Documentation:User_Manual:Chapter2|Chapter 2. Configuring Your Applications]]<br />
+
[[SME_Server:Documentation:User_Manual:Chapter2|Chapter 2. Configuring Applications]]<br />
[[SME_Server:Documentation:User_Manual:Chapter3|Chapter 3. User File Storage on the SME Server]]<br />
+
[[SME_Server:Documentation:User_Manual:Chapter3|Chapter 3. File Storage]]<br />
 
[[SME_Server:Documentation:User_Manual:Chapter4|Chapter 4. Webmail]]<br />
 
[[SME_Server:Documentation:User_Manual:Chapter4|Chapter 4. Webmail]]<br />
  
 
----
 
----
'''[[SME_Server:Documentation:Technical_Manual|Technical Manual]]'''<br />
+
'''[[SME_Server:Documentation:Developers_Manual|Developers Manual : Index page]]'''
[[SME_Server:Documentation:Technical_Manual:Chapter1|Chapter 1. Included Software Configuration]]<br />
+
 
[[SME_Server:Documentation:Technical_Manual:Chapter2|Chapter 2. Adding New Software]]<br />
+
Direct chapter links:
[[SME_Server:Documentation:Technical_Manual:Chapter3|Chapter 3. Notes for Contrib Authors]]<br />
 
[[SME_Server:Documentation:Technical_Manual:Chapter4|Chapter 4. Finding Answers]]<br />
 
[[SME_Server:Documentation:Technical_Manual:Chapter5|Chapter 5. How you can help]]<br />
 
[[SME_Server:Documentation:Technical_Manual:Chapter6|Chapter 6. Command Line Configuration]]<br />
 
[[SME_Server:Documentation:Technical_Manual:Chapter7|Chapter 7. Custom Templates]]<br />
 
[[SME_Server:Documentation:Technical_Manual:Chapter8|Chapter 8. Hardware Configuration]]<br />
 
  
----
+
[[SME_Server:Documentation:Developers_Manual:Section1|Section I. An overview of the SME Server]]<br />
'''[[SME_Server:Documentation:Developers_Manual|Developers Manual]]'''<br />
+
[[SME_Server:Documentation:Developers_Manual:Section2|Section II. SME Server internals]]<br />
[[SME_Server:Documentation:Developers_Manual|SME Developer Documentation]]<br />
+
[[SME_Server:Documentation:Developers_Manual:Section3|Section III. How to create an SME Server package - step by step]]<br />
 +
[[SME_Server:Documentation:Developers_Manual:Section4|Section IV. Advanced customization of the SME Server]]<br />
 +
[[SME_Server:Documentation:Developers_Manual:Section5|Section V. Documentation and resources]]<br />
 +
[[SME_Server:Documentation:Developers_Manual:Section6|Section VI. License texts]]<br />
 +
 
 +
 
 +
{{Note box|The manuals are protected from general editing. Add proposed changes to the discussion tab.}}
  
----
+
[[Category:SME Server]]
'''Other Documention'''<br />
 
[[SME_Server:Documentation:Administration_Manual:FAQ|SME Frequently Asked Questions]]<br />
 
[[SME_Server:Documentation:Administration_Manual:HowTo|SME How To's]]<br />
 

Latest revision as of 19:28, 21 April 2021


The Koozali SME Server project

The Koozali Foundation Inc. is a nonprofit corporation that governs the open source Koozali SME Server project. Koozali SME Server is a stable, secure and easy to use/manage linux server that provides common server functionalities out of the box. Many open source contributions are available that can extend the default server functionality making Koozali SME Server an even more powerful and flexible business server solution. Thousands of Koozali SME Severs have been deployed as real or virtual servers and in the cloud to serve many small to medium enterprises, and this number is growing day by day. The Koozali SME Server is free to use but it takes a lot of effort and money to develop, make, and maintain. We therefore ask you for your considerations.

Volunteering

Koozali Foundation Inc. together with its community hosted at https://contribs.org is a collaborative effort of volunteers. You too can contribute to the development and continuity of the Koozali SME Server project as described on our volunteering page. Everybody is welcome to join the already 4000+ member contribs.org community and can contribute with any skill set.

Financial donations

You can also show your support by making financial donations. The preferred way to make financial donations is using the donate option in the forums. You are free to choose any amount and frequency, being monthly, yearly or only once. The benefit of donating through your forums account is that your forum user name will receive a badge, showing your donation status. If you do not have a forum account, you can create one, or select the below PayPal option to make your donations.

Commercial usage

Organizations that use Koozali SME Server for their business, provide professional services related to SME Server or in any other way benefit commercially from the Koozali SME Server project, are kindly requested to consider regular financial donations that reflect their business benefits.

Koozali Foundation Inc. is happy to supply an invoice for any donations received. For more information on invoicing please send a mail to treasurer@koozali.org.

Thank you for your considerations and support!


SME Server Manuals

There are three main manuals:

The Administration Manual
Describes installation and day to day operation by the Server Administrator.

The User Manual
Provides information to help users configure their client applications, and interact with the server.

The Developers Manual
Contains information required to integrate applications into SME.

There are also Frequently Asked Questions, Howto, Contrib Collections, and a Temporary release critical doc Update Status page -- this will be removed on release of v.10.


Administration Manual : Index page

Direct chapter links:

Chapter 1. Welcome to SME Server 10
Chapter 2. The role of the SME Server
Chapter 3. Your Internet Service Provider (ISP)
Chapter 4. Hardware requirements of the SME Server
Chapter 5. Installing and configuring your SME Server Software
Chapter 6. The Server Console
Chapter 7. Configuring the computers on your network
Chapter 8. On-going administration using the server-manager
Chapter 9. server-manager : Collaboration
Chapter 10. server-manager : Administration
Chapter 11. server-manager : Security
Chapter 12. server-manager : Miscellaneous
Chapter 13. server-manager : Configuration
Chapter 14. Information Bays (i-bays)
SME Manual Appendix
SME Manual Glossary


User Manual : Index page

Direct chapter links:

Chapter 1. Remote Access
Chapter 2. Configuring Applications
Chapter 3. File Storage
Chapter 4. Webmail


Developers Manual : Index page

Direct chapter links:

Section I. An overview of the SME Server
Section II. SME Server internals
Section III. How to create an SME Server package - step by step
Section IV. Advanced customization of the SME Server
Section V. Documentation and resources
Section VI. License texts


  Note:
The manuals are protected from general editing. Add proposed changes to the discussion tab.