[Checkins] SVN: Sandbox/philikon/zopeproject/trunk/ ENabled apidoc
and developer-mode by default
Philipp von Weitershausen
philikon at philikon.de
Sat Sep 29 11:03:02 EDT 2007
Log message for revision 80395:
ENabled apidoc and developer-mode by default
Documented deployment a bit. Not very extensive.
Changed:
U Sandbox/philikon/zopeproject/trunk/CHANGES.txt
U Sandbox/philikon/zopeproject/trunk/README.txt
A Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/apidoc.zcml
U Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/buildout.cfg_tmpl
U Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/site.zcml_tmpl
U Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/zope.conf
-=-
Modified: Sandbox/philikon/zopeproject/trunk/CHANGES.txt
===================================================================
--- Sandbox/philikon/zopeproject/trunk/CHANGES.txt 2007-09-29 14:36:59 UTC (rev 80394)
+++ Sandbox/philikon/zopeproject/trunk/CHANGES.txt 2007-09-29 15:03:02 UTC (rev 80395)
@@ -12,6 +12,9 @@
* Added a ``bin/python`` script that mimicks an interpreter.
+* Enabled the APIDoc tool by default. You may access it under
+ http://localhost:8080/++apidoc++.
+
* Simplified ``*package*/testing.py``.
0.4 (2007-09-15)
Modified: Sandbox/philikon/zopeproject/trunk/README.txt
===================================================================
--- Sandbox/philikon/zopeproject/trunk/README.txt 2007-09-29 14:36:59 UTC (rev 80394)
+++ Sandbox/philikon/zopeproject/trunk/README.txt 2007-09-29 15:03:02 UTC (rev 80395)
@@ -419,6 +419,48 @@
login screen) or NotFound (which normally leads to an HTTP 404
response) will trigger the debugger.
+Deploying
+=========
+
+Disabling debugging tools
+-------------------------
+
+Before deploying a zopeproject-based application, you should make sure
+that any debugging tools are disabled. In particular, this includes
+
+* making sure there's no debugging middleware in ``deploy.ini``
+ (normally these should be configured in ``debug.ini`` anyway),
+
+* switching off ``developer-mode`` in ``zope.conf``,
+
+* disabling the APIDoc tool in ``site.zcml``,
+
+* disabling the bootstrap administrator principal in ``site.zcml``.
+
+Linux/Unix
+----------
+
+You can use the ``helloworld-ctl`` script to start the server process
+in daemon mode. It works much like the ``apachectl`` tool as known
+from the Apache HTTPD server or INIT scripts known from Linux::
+
+ $ bin/helloworld-ctl start
+
+To stop the server, issue::
+
+ $ bin/helloworld-ctl stop
+
+Other commands, such as ``status`` and ``restart`` are supported as
+well.
+
+Windows
+-------
+
+There's currently no particular support for deployment on Windows
+other than what ``paster`` provides. Integration with Windows
+services, much like what could be found in older versions of Zope, is
+planned.
+
Reporting bugs or asking questions about zopeproject
====================================================
Added: Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/apidoc.zcml
===================================================================
--- Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/apidoc.zcml (rev 0)
+++ Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/apidoc.zcml 2007-09-29 15:03:02 UTC (rev 80395)
@@ -0,0 +1,13 @@
+<configure xmlns="http://namespaces.zope.org/zope">
+ <include package="zope.app.zcmlfiles" file="meta.zcml" />
+ <include package="zope.app.preference" file="meta.zcml" />
+ <include package="zope.app.apidoc" file="meta.zcml" />
+ <include package="zope.app.onlinehelp" file="meta.zcml" />
+
+ <include package="zope.app.zcmlfiles" />
+ <include package="zope.app.tree" />
+ <include package="zope.app.onlinehelp" />
+ <include package="zope.app.renderer" />
+ <include package="zope.app.preference" />
+ <include package="zope.app.apidoc" />
+</configure>
Property changes on: Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/apidoc.zcml
___________________________________________________________________
Name: svn:eol-style
+ native
Modified: Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/buildout.cfg_tmpl
===================================================================
--- Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/buildout.cfg_tmpl 2007-09-29 14:36:59 UTC (rev 80394)
+++ Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/buildout.cfg_tmpl 2007-09-29 15:03:02 UTC (rev 80395)
@@ -8,6 +8,7 @@
[app]
recipe = zc.recipe.egg
eggs = ${egg}
+ zope.app.apidoc
zope.app.securitypolicy
z3c.evalexception>=2.0
Paste
Modified: Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/site.zcml_tmpl
===================================================================
--- Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/site.zcml_tmpl 2007-09-29 14:36:59 UTC (rev 80394)
+++ Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/site.zcml_tmpl 2007-09-29 15:03:02 UTC (rev 80395)
@@ -3,6 +3,10 @@
<include package="${package}" />
+ <!-- Remove this reference to disable the APIDoc tool.
+ You should do this for production -->
+ <include file="apidoc.zcml" />
+
<include package="zope.app.securitypolicy" file="meta.zcml" />
<include package="zope.app.securitypolicy" />
<securityPolicy
@@ -16,6 +20,8 @@
title="Authenticated Users" />
<everybodyGroup id="zope.Everybody"
title="All Users" />
+
+ <!-- Initial administrator account. Disable this for production -->
<principal id="zope.manager"
title="Manager"
login="${user}"
Modified: Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/zope.conf
===================================================================
--- Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/zope.conf 2007-09-29 14:36:59 UTC (rev 80394)
+++ Sandbox/philikon/zopeproject/trunk/zopeproject/zope_deploy/zope.conf 2007-09-29 15:03:02 UTC (rev 80395)
@@ -34,5 +34,6 @@
</logfile>
</eventlog>
-# Uncomment this to switch on developer mode (e.g. for APIDoc)
-#devmode on
+# Comment this line to disable developer mode. This should be done in
+# production
+devmode on
More information about the Checkins
mailing list