This is a work in progress to develop a way to re-organise and consolidate the pages / documents in the OFBTECH Technical Documentation Workspace and migrate them into the Wiki.
Welcome to the OFBiz Technical Documentation Wiki.
In this wiki you will find a wide range information to help you setup, use or develop OFBiz.
Getting Started
Once you have verified the minimum system requirements, you can download, build and then run your own version of OFBiz. Anyone looking to administer OFBiz will need to read the Apache OFBiz Technical Production Setup Guide.
If you are going to be using OFBiz in other languages or currencies then please take a look at our Internationalization / Localisation Guide.
Information for Developers
There are several resources available if you are going to be developing in OFBiz, a Beginners Tutorial, some detailed background information on the Data Model that OFBiz is built on, a detailed guide that describes the Entities and also the Service Engine. We also have a section on FAQs, Tips & Tricks and How Tos. (NOTE: May need to split that FAQ page up because its has more tips and tricks and how tos rather than being really question based)
Upgrading form a Previous OFBiz Version
If you are upgrading from a previous version of OFBiz then please take a look at the Data Migration Guide which can be used in conjunction with the Apache OFBiz Technical Production Setup Guide
Look at creating a Table of Contents that has the list of all the Technical Guides
Table of Contents
Setting Up Security (note from Jacques that OFBiz Security is more about authorisation not authentication and more (but OFBIz is quite secure)
Service Engine Guide — already updated by Scott! ~jacques.le.roux: http://ofbiz.apache.org/docs/services.html (would be cool to make new up to date wiki pages from those old pages like also http://ofbiz.apache.org/docs/entity.html and remove them)
Entity Engine Guide (this needs to come across to the new format) http://ofbiz.apache.org/docs/entity.html
Technical Production Setup Guide
Developer Area ?
Developer Best Practices Guide
Do we have:
- an OFBiz Installation Guide? ~jacques.le.roux: for me that's Apache OFBiz Technical Production Setup Guide (added above) SF: Thanks Jacques - I think we might need to extract some info into a specific page or rename things because installing OFBiz it doesnt necessarily mean a Production Setup.
- an Upgrade / Data Migration Guide? ~jacques.le.roux: for me that's Data Migration Guide (added above) : SF: Good - I will check this over.
- a Minuimum System Requirements Guide? ~jacques.le.roux: System Requirements SF: Good
- a System Administration Guide? ~jacques.le.roux: nope only Apache OFBiz Technical Production Setup Guide SF: Once again we might need to extract some info into a specific page around this topic.
Things to incorporate:
- Technical Production Setup Guide ~jacques.le.roux: for me that's Apache OFBiz Technical Production Setup Guide (added above)
- Scaling and Performance - I think this should be a part of the system admin guide ~jacques.le.roux: for me that's Scaling and Performance Plan