[Zope3-checkins] CVS: Zope3/doc - INSTALL.txt:1.33
R. David Murray
bitz@bitdance.com
Thu, 8 Aug 2002 17:10:01 -0400
Update of /cvs-repository/Zope3/doc
In directory cvs.zope.org:/tmp/cvs-serv2277
Modified Files:
INSTALL.txt
Log Message:
This is a straightforward update to the z2 version of this doc
to include details from the 'sandbox' article in the wiki.
It's accurate as far as I know, but the notes in 'Random Details'
about python compilation and RPMs may be out of date.
Comments and improvements welcome. Including comments that this
shouldn't exist yet, if that's your opinion.
=== Zope3/doc/INSTALL.txt 1.32 => 1.33 ===
--- Zope3/doc/INSTALL.txt:1.32 Wed May 29 15:58:57 2002
+++ Zope3/doc/INSTALL.txt Thu Aug 8 17:10:01 2002
@@ -1,80 +1,82 @@
Building and installing Zope from source
----------------------------------------
- This document describes building and installing Zope on Unix.
+ This document describes building and installing Zope3 on Unix.
We will provide Windows instructions in later releases. We
will also provide binary releases for some platforms.
Important notes
- ZOPE 2.5 REQUIRES PYTHON 2.1.X!
+ ZOPE 3 REQUIRES PYTHON 2.2.1!
- Note: Using Python 2.2 is not recommended and not supported.
+Quick Start
- See CHANGES.txt for important notes on Zope 2.5.
+ The following commands should get you up and running with the
+ development version of Zope3 on Unix:
+ * If you have not yet checked out the CVS tree, do so::
-Quick Start
+ cvs -d:pserver:anonymous@cvs.zope.org:/cvs-repository login
+ cvs -d:pserver:anonymous@cvs.zope.org:/cvs-repository co Zope3
+
+ Press return when prompted for a password.
+
+ * Make sure you have expat-1.95.2 installed (the easiset way to do
+ this is to install pyxml 0.7.0 (*not* 0.7.1, it's broken).
- If you are impatient, the following commands should get you up and
- running with Zope 2 using ZServer and ZODB 3 on Unix::
+ * cd Zope3
- python w_pcgi.py # Note, this must be Python 2.1
- ./start
+ * python stupid_build.py
- The first command builds and adjusts Zope. Take note of the user
- name and password output at the end of this command. You will need
- these to manage Zope.
-
- If you get errors indicating that addresses are in use, then you
- will have to supply arguments to z2.py to change the ports used for
- HTTP or FTP. The default HTTP and FTP ports used by ZServer are 8080
- and 8021 respectively. (See the help for the z2.py script by running
- z2.py with the -h option for more information on how to specify
- different ports)
-
- You can then connect to Zope 2 by directing your browser to::
-
- http://yourhost:8080/manage
-
- where yourhost is the name or address of the machine running Zope 2.
- If you changed the HTTP port with the -w option to z2.py, then use
- it rather than 8080.
+ * Copy principals.zcml.in to principals.zcml, and add a manager
+ entry to it based on the examples in sample_principals.zcml.
+
+ * python z3.py
+
+ You should shortly see logging messages indicating Zope3 is listening on
+ port 8080. At that point you can connect to Zope3 by directing
+ your browser to::
+
+ http://yourhost:8080
+
+ where yourhost is the name or address of the machine running Zope 3.
You will be prompted for a user name and password. Use the user name
- and password output above.
+ and password you entered into your principals.zcml file.
- Now you're off and running! You should be looking at the Zope management
- screen which is divided into two frames. On the left you can navigate
- between Zope object and on the right you can edit them by selecting
- different management functions with the tabs at the top of the frame.
-
- If you haven't used Zope before, you should head to the Zope web site
- and read some documentation. The Zope Manager's Guide is a good place
- to start. You can access the Zope site at:
-
- 'http://www.zope.org/'
-
- Have fun!
+ Now you're off and running!
-Building Zope
+Resources
+
+ If you haven't used Zope3 before, you should head to the Zope web site
+ and read some documentation. The Zope3PythonProgrammersTutorial is a good
+ place to start. You can access it on the Zope site at::
- There are some python scripts in the top-level directory that should
- help you get started. You must run these scripts from the top-level
- directory.
+ http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture/ProgrammerTutorial
- If you want to try out Zope in the simplest fashion using ZServer,
- then run the script wo_pcgi::
+ You will also find some additional documentation in the 'doc'
+ directory of the Zope3 tree, where this file lives. All other
+ existing Zope3 documentation is linked from somewhere in the Zope
+ project Wiki:
- python wo_pcgi.py
+ 'http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture'
- If you want to use PCGI and an existing web server run w_pcgi::
+ You may also want to subscribe to the Zope3-dev mailing list::
- python w_pcgi.py
+ http://lists.zope.org/mailman/listinfo/zope3-dev
+
+ Have fun!
- Notes
+Random Details
- * You should be using Python 2.1 to run the build scripts.
+ * There are some python scripts in the top-level directory that will help
+ you track changes during the development process. Specifically,
+ 'stupid_clean.py' should be run before you do a new 'stupid_build.py'
+ when you are doing a cvs update of your checkout, and 'test.py' will
+ run all of the unit tests (see UNITTEST.txt in the doc directory for more
+ information on unit tests).
+
+ * You should be using Python 2.2.1 or later to run anything related to Zope3.
* The python you run Zope with *must* have threads compiled in,
which is *not* the case for a vanilla build. When you build the
@@ -89,50 +91,3 @@
* If you just want to use Zope components it's not necessary to build Zope
but it's a good idea since it will compile Python C extensions for you.
-
- * You can use PCGI and an existing web server if you use ZServer.
-
-Starting Zope with an existing web server
-
- See the WEBSERVERS.txt file for more information about configuring Zope
- with an existing web server. See also the pcgi/README file for further
- informations on the installation of PCGI.
-
-Running Zope
-
- There are two ways to run Zope:
-
- - You can use ZServer, the integration of Zope and Medusa. You must
- use ZServer if you want to use multiple concurrent threads.
- ZServer is a server application that supports multiple protocols:
-
- o HTTP -- ZServer is a Web server
-
- o FTP -- ZServer is a file-transfer protocol server. This
- allows you to use FTP-enabled publishing systems with Zope.
-
- o PCGI -- PCGI is a lightweight protocol for forwarding
- requests from other web servers, like Apache or Netscape, to
- Zope. This makes it possible to use web server features like
- connection encryption or logging with Zope.
-
- o monitor -- ZServer has the capability to allow you to access
- the Python interpreter directly over a network channel. If
- you intend to use this, please read the 'DEBUGGING.txt'
- document for more information.
-
- With ZServer, you must start Zope manually using the z2.py script.
- Typically, the command used to run the z2.py script will be put in
- system startup scripts.
-
- ZServer is the prefered way to run Zope.
-
- - If you *only* want to use PCGI and you don't need multi-threaded
- operation, you can have a special program, the pcgi_publisger,
- start Zope for you. See the WEBSERVER.txt file for details on
- using Zope with an existing webserver.
-
- If you wish to enable Zope logging you must specify options on the
- command line. See LOGGING.txt in the doc directory.
-
-