Difference between revisions of "Introduce a new developer to Organic Design"
From Organic Design wiki
(from ewg.od) |
|||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{legacy|Development guidelines}} | ||
{{procedure | {{procedure | ||
| role = sysop | | role = sysop | ||
| Line 4: | Line 5: | ||
}} | }} | ||
| − | == Organic Design Servers == | + | == Wiki/Wikia configuration == |
| − | All our servers are installed with the [[ | + | Most of the settings required are already configured in the [http://svn.organicdesign.co.nz/filedetails.php?repname=extensions&path=%2Fwikia.php wikia.php] script in out ''extensions' svn repo, but some settings such as the wiki's name, its database details and its extensions are still necessary. See our sample file [http://svn.organicdesign.co.nz/filedetails.php?repname=extensions&path=%2FLocalSettings.sample.php LocalSettings.sample.php] which covers most of the common conventions for a wiki intended for Organic Design wiki organisation use. One other related file is [http://svn.organicdesign.co.nz/filedetails.php?repname=extensions&path=%2Fwikia.i18n.php wikia.i18n.php] which contains all the internationalised messages used by OD wiki organisational systems. See the [[install a new wiki]] for more detail. |
| + | |||
| + | == Organic Design Servers & Packages == | ||
| + | All our servers are installed with the [[Install a new server|install a new server procedure]] which starts with the installation of the [[organicdesign-server]] package and then takes you through configuration of Apache/PHP/MySQL and our [[OD/Wikia|Wikia structure]]. After that a number of other more specific procedures can be carried out which are described below. | ||
| + | |||
| + | The [[organicdesign-server]] package is in our [http://packages.organicdesign.co.nz/main packages.organicdesign.co.nz/main] repository along with the [[organicdesign-workstation]] package which is used to install workstations to be used by members running our organisational system. To update tehse packages, see the [[Create or Update a Debian package]] procedure. | ||
| + | |||
| + | Later we like to be able to maintain our own tree of distro's all based on the server and workstation packages which are preloaded with our own software and content and exhibit a simple setup procedure to create the initial configuration structure. | ||
== Organic Design Procedures == | == Organic Design Procedures == | ||
| − | The most important set of procedures is the [[ | + | The most important set of procedures is the [[:Category:Sysop procedures|sysop procedures]], and out of these the most key ones are: |
| − | *[[ | + | *[[Install a new organisational system]] ''- Starting from scratch with a new project or business'' |
| − | *[[ | + | *[[Install a new server]] ''- Sets up the core IT infrastructure'' |
| − | *[[ | + | *[[Install a new wiki]] ''- Get the [[Wiki Organisation]] interface and robot-framework running'' |
| − | *[[ | + | *[[Configure mail server]] ''- Exim4 MTA with Spamassassin, Dovecot IMAP server and Roundcube webmail'' |
| − | *[[ | + | *[[Configure LAN]] ''- DHCP server and firewall for LAN based servers'' |
| − | *[[ | + | *[[Configure DNS]] ''- LAN/Server based DNS and dynamic DNS solutions'' |
| − | *[[ | + | *[[Configure SMB]] ''- Samba file shares'' |
| + | *[[Configure VPN]] ''- Remote access to file shares and other LAN resources'' | ||
| + | *[[Configure IRC]] ''- Run a chat channel, your bot can publish notifications to the channel'' | ||
| + | *[[Configure SVN]] ''- Set up Subversion repositories, web-svn and client svn access'' | ||
== Organic Design Code == | == Organic Design Code == | ||
| − | Our Subversion repos at [http://svn.organicdesign.co.nz/ svn.organicdesign.co.nz] contain all our code, only the ''extensions'' and ''tools'' repo's are active. The ''extensions'' repo contains all the [[MW:User:Nad|MediaWiki extensions we maintain]] which are not popular enough to be in the official [http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/ MediaWiki repo]. See the [[ | + | Our Subversion repos at [http://svn.organicdesign.co.nz/ svn.organicdesign.co.nz] contain all our code, only the ''extensions'' and ''tools'' repo's are active. The ''extensions'' repo contains all the [[MW:User:Nad|MediaWiki extensions we maintain]] which are not popular enough to be in the official [http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/ MediaWiki repo]. See the [[Configure SVN|configure SVN procedure]] for details about our Subversion setup and how to access it. The ''tools'' repo contains all our server tools and robot framework mainly written in Perl. Here's a quick run down of the important scripts and files: |
*[http://svn.organicdesign.co.nz/filedetails.php?repname=tools&path=%2Fadd-db add-db] ''- a script for adding a new MediaWiki database to MySQL from a template database dump'' | *[http://svn.organicdesign.co.nz/filedetails.php?repname=tools&path=%2Fadd-db add-db] ''- a script for adding a new MediaWiki database to MySQL from a template database dump'' | ||
*[http://svn.organicdesign.co.nz/filedetails.php?repname=tools&path=%2Fdovecot-cert.sh dovecot-cert.sh] ''- create/update the self-signed cert for the local Dovecot installation'' | *[http://svn.organicdesign.co.nz/filedetails.php?repname=tools&path=%2Fdovecot-cert.sh dovecot-cert.sh] ''- create/update the self-signed cert for the local Dovecot installation'' | ||
| Line 28: | Line 39: | ||
== Useful links about Organic Design in general == | == Useful links about Organic Design in general == | ||
| − | *[[ | + | *[[Organic Ontology]] ''- trees, mindmaps and diagrams showing all the aspects of OD'' |
| − | *[[ | + | *[[Manifesto]] ''- our goals and philosophy'' |
*[https://ewg.organicdesign.co.nz/files/5/51/Ra_project.ogv Screencast example of RecordAdmin usage] | *[https://ewg.organicdesign.co.nz/files/5/51/Ra_project.ogv Screencast example of RecordAdmin usage] | ||
Latest revision as of 21:28, 15 September 2019
|
|
Introduce a new developer to Organic Design Organic Design procedure |
Contents
Wiki/Wikia configuration
Most of the settings required are already configured in the wikia.php script in out extensions' svn repo, but some settings such as the wiki's name, its database details and its extensions are still necessary. See our sample file LocalSettings.sample.php which covers most of the common conventions for a wiki intended for Organic Design wiki organisation use. One other related file is wikia.i18n.php which contains all the internationalised messages used by OD wiki organisational systems. See the install a new wiki for more detail.
Organic Design Servers & Packages
All our servers are installed with the install a new server procedure which starts with the installation of the organicdesign-server package and then takes you through configuration of Apache/PHP/MySQL and our Wikia structure. After that a number of other more specific procedures can be carried out which are described below.
The organicdesign-server package is in our packages.organicdesign.co.nz/main repository along with the organicdesign-workstation package which is used to install workstations to be used by members running our organisational system. To update tehse packages, see the Create or Update a Debian package procedure.
Later we like to be able to maintain our own tree of distro's all based on the server and workstation packages which are preloaded with our own software and content and exhibit a simple setup procedure to create the initial configuration structure.
Organic Design Procedures
The most important set of procedures is the sysop procedures, and out of these the most key ones are:
- Install a new organisational system - Starting from scratch with a new project or business
- Install a new server - Sets up the core IT infrastructure
- Install a new wiki - Get the Wiki Organisation interface and robot-framework running
- Configure mail server - Exim4 MTA with Spamassassin, Dovecot IMAP server and Roundcube webmail
- Configure LAN - DHCP server and firewall for LAN based servers
- Configure DNS - LAN/Server based DNS and dynamic DNS solutions
- Configure SMB - Samba file shares
- Configure VPN - Remote access to file shares and other LAN resources
- Configure IRC - Run a chat channel, your bot can publish notifications to the channel
- Configure SVN - Set up Subversion repositories, web-svn and client svn access
Organic Design Code
Our Subversion repos at svn.organicdesign.co.nz contain all our code, only the extensions and tools repo's are active. The extensions repo contains all the MediaWiki extensions we maintain which are not popular enough to be in the official MediaWiki repo. See the configure SVN procedure for details about our Subversion setup and how to access it. The tools repo contains all our server tools and robot framework mainly written in Perl. Here's a quick run down of the important scripts and files:
- add-db - a script for adding a new MediaWiki database to MySQL from a template database dump
- dovecot-cert.sh - create/update the self-signed cert for the local Dovecot installation
- jobs - specialised jobs can be created which run in the background
- firewall.sh - template for a basic firewall for LAN-based servers
- wiki.pl - our script for interacting with MediaWiki's via HTTP
- wikid.pl - our main robot/daemon script, see wiki daemon for more detail
- wikid.conf.sample - sample configuration file for Wikia/robot framework
Useful links about Organic Design in general
- Organic Ontology - trees, mindmaps and diagrams showing all the aspects of OD
- Manifesto - our goals and philosophy
- Screencast example of RecordAdmin usage
