Note
Important Notes
Please do this setup as soon as possible. This way, if you run into problems, there's time to help you. If you come to class without a working setup, it will be too late to get you set up properly for class.
Sorry, but your current setup won't work. You must set things up this way, in a fresh, new installation. Otherwise, you won't get all the sample products and code we'll use in class.
You should follow these instructions exactly. The names of the various files and locations were specifically chosen and are required for our products. Don't install things in other places or attempt to use your own configuration. It won't work.
If you've come to a previous class of ours, you should still follow these instructions from the top. This will give you a fresh, separate installation with the correct software for this class.
Thanks!
The following are the easiest and best setups. It should take less than 30 minutes to get running for most people.
Windows (either XP or Vista is fine)
Linux (any distribution will do)
OSX 10.4 or 10.5
The following may work, but aren't supported in class. You're welcome to try, but we won't be able to provide support for installing these setups.
FreeBSD, Solaris, or other non-Linux Unix operating systems (to try these, follow the Linux instructions)
Any setup involving VMWare or similiar virtual machines
The following will not work. Sorry!
Any setup requiring an Internet connection to use Plone in class (such as trying to use a remote server over HTTP, or through a tunnel or VPN)
Note
What Operating System Should I Use?
Use the operating system you know and like best. Don't assume that you should use Linux in class just because you've been told you will use a Linux server for deploying your Plone site (as you'll learn, Plone works the same on all operating systems, so there's no benefit "learning it" on Linux. You'll have a much better experience in class using an operating system you're already comfortable with.
Don't use VMWare or other virtual machines. They may get in the way of working efficiently and understanding how things work. The entire setup we use will be in only one directory, which you can simply delete after class, if you no longer want it. There are no registry settings or Windows changes made by the installation/class process.
Note
Do I Need to Create a New User, Partion, Virtual Machine, etc?
No. The entire setup we use in class will be in only one directory, which can you simply delete after class, if you don't want it. There's no need to create a new user, partition, or virtual machine for this.
Note
Problems with these instructions?
First, check the Frequently Asked Questions at the end. If your question isn't answered there, then send email to the class mailing list, and hopefully one of the other students or the trainer can help out.
We will be using the Beta Buildout Installer for Plone. It is not acceptable to use the standard Plone installer.
You should download and run the installer at:
http://tinyurl.com/3-2-1-win
When you run the installer, it will prompt you for the location to install Plone. You must install this in a particular location: c:\sf3 (all lower case). Do not use the default location the installer suggests (c:\Program Files\Plone 3), or anywhere else.
It will also prompt you for a username and password for the administrative user--you must use "admin" (all lower case, spelled like this) for both username and password. You can always change them after class, should you want something different then.
You do not need to install Zope or Python separately, and should not do so. It's fine if you already have these installed--but the installer you just used will ignore those and install safe, independent copies for use in class.
You must install Firefox. It's fine if use Internet Explorer (or another browser) for your regular usage. We will, however, need Firefox in class.
http://www.mozilla.com/firefox/
Any version of Firefox will do.
A fantastically useful add-on for Firefox; we'll be using this to learn to how to stylize Plone, bug fix CSS errors, etc. It's a very easy install once Firefox is set up:
http://chrispederick.com/work/webdeveloper/
Open a DOS shell (Start Menu -> Run -> cmd), and change to your "buildout directory" (type or copy and paste the parts in bold, the italicized parts are the prompts you see):
C:\> cd \sf3 C:\sf3>
Install the configuration script, pbconfig.
C:\sf3> python\python.exe python\Scripts\easy_install-script.py
-f http://dist.plonebootcamps.com/sf3 plonebootcamps.configure
(This should be entered as one line; it splits here over two lines just because of length)
You can cut and paste this line into your DOS prompt, if you'd prefer. Here it is on one line:
python\python.exe python\Scripts\easy_install-script.py -f http://dist.plonebootcamps.com/sf3 plonebootcamps.configure
Run the configuration script, pbconfig.
C:\sf3> python\python.exe python\Scripts\pbconfig-script.py sf3
During this process, you may get a pop-up window to accept the license terms of "Junction", a free Windows-specific utility. If so, please click to accept this.
Regenerating your buildout pulls down any add-on products you need and updates your software. This will take several moments, and requires Internet connectivity.
To do this, in the same DOS shell window, enter:
C:\sf3> buildout
Note
No "bin" In That!
This is buildout, not bin\\buildout (that's the normal command for updating buildout on other operating systems). Instead, you want to use the .bat file found at the top of your buildout directory.
The first time you run buildout, it will take several minutes. If it is successful, it will end with a line like:
Generated script: c:\ ... \restore
Any time you run buildout after this, it is likely to end succesfully with the line:
Updating backup.
You should now start up your Plone server.
C:\sf3> instance fg
Please note that, when starting up, you'll see lots of messages on the screen, including some "INFO" messages about files not being found, or "Deprecation Warnings", etc. These are nothing to worry out.
It has started successfully when it says "Zope is ready to serve requests". This may take a few minutes. If it returns to a DOS prompt, it did not start up successfully.
It's very important to test your setup before class.
Go to your web browser and view:
http://localhost:8085/dashboard
If this returns an "Failed to connect" error (or any other kind of "can't reach webserver"-type error), your Plone server has not been started. See the instructions above on starting the server.
If this returns a SiteError "Resource not found", you've installed Plone, but not our custom software (which you'll need for class). Please check the instructions again, and seek help on the mailing list.
If this returns a page headed PloneBootcamps Zope Dashboard, this was successful. Good work!
We will be using a Java-based graphical editor called "ArgoUML". It should be installed automatically by the setup instructions. However, it is possible it may not work if you don't have Java installed or if you have an old/broken Java installation.
Go into a new DOS shell, and change into your "buildout directory" (using the same location as before):
C:\> cd \sf3 C:\sf3>
Start up ArgoUML.
C:\sf3> bin\argouml
This should give you, after a moment, a startup dialog box for ArgoUML. If it gives you an error, or no response, you should check your Java setup, and, if necessary, install ArgoUML by hand from their site:
You can stop your server by switching to the DOS shell where it is running. Press CONTROL-C to kill the process. You may have to confirm this quit with a "y" answer.
After class, you can uninstall all the software you've installed by simply deleting the c:\sf3 directory. There are no registry settings or uninstall steps you must perform.
Problem:
When I run easy_install, I get:
[Download errors: (10061: 'Connection refused')](sometimes these also appear as "Connection Not Found" or similar errors)
Answer:
Almost certainly, you're trying this behind a corporate firewall, and Python doesn't know how to get through this firewall.
You can fix this by setting an evironmental variable with the firewall information:
Setup an environment variable "HTTP_PROXY" that points to your proxy server, of the form: user:password at server:portEasier for many people will be to just try the install from home, or a wireless cafe, where you won't have to worry about going through your firewall.
Problem:
I get this when I run buildout:
An internal error occured due to a bug in either zc.buildout or in a recipe being used: OSError: [Errno 13] Permission denied: 'C:\\Plone\\parts\\plone\\CMFActionIcons'
Answer:
This is almost certainly Vista trying to help you with UAC (User Access Control).
Please disable UAC.
(You can try method #4 from http://www.petri.co.il/disable_uac_in_windows_vista.htm)
Problem:
When I run pbconfig, I get:
You either did install your Plone into the proper location, or you are not in your buildout directory.
Answer:
You did not choose the correct location (c:sf3) for the installation of your Plone software. You must use this location, and spell it correctly (capitalization counts!) Please delete the directory where you installed Plone, and re-run the installer with this location (also, note that you must use the username and password provided in the installation instructions, too).
Problem:
I renamed my buildout directory, and get an error when I try to run buildout:
Traceback (most recent call last): File "bin\buildout-script.py", line 9, in ? import zc.buildout.buildout ImportError: No module named zc.buildout.buildout
Answer:
You can't just rename the directory of your buildout, as Windows has all sorts of registry settings now about where your python libraries are there (you may have noticed that you can't rename folders in "Program Files" under Windows--same thing here).
Run the installer again, with the correct location, as given above.
Problem:
I tried going to http://localhost:8085/Plone, but got a not-found error. Where's my Plone site?
Answer:
The Windows installer no longer creates an initial site when you set up the software, so you shouldn't have one on Windows.
Do not try to create a Plone site before we come to class. We will do this in class together.
Note
Problems with these instructions?
Send email to the class mailing list, and hopefully one of the other students or the trainer can help out.
Note
What Linux distribution should I use?
You can use any one you'd like; Plone works equally well on all. If you have no preference, Ubuntu is the most popular and most widely-supported Linux distribution nowadays; you may find the most people able to help you if you use that. (Also, your instructor will almost certainly be running Ubuntu).
However, even if you use Ubuntu, you should not use their packaged version of Plone. Always use these instructions for the very class-specific setup.
This step is optional--if you leave it out, the Plone installer will try to compile these things directly. However, if you install them beforehand, you will have a slightly faster time installing Plone, and you will be able to install multiple Plone installations that can share these libraries.
Install the development packages for the following libraries:
libz
libjpeg
libxml2
In Ubuntu, you can do this easily as:
$ sudo apt-get install libz-dev libjpeg-dev libxml2-dev
If you can't do this step, don't worry--just proceed with the next step. Things will work just fine.
We will be using the Unified Installer for Plone. This will install Plone at ~/Plone.
Note
I Already Have Plone Installed There!
If you already have Plone installed there, you have several options:
You can delete/move the existing directory at ~/Plone. If you move it, it will still work fine. Then you can proceed with the instructions.
You can install the course software somewhere else. To do this, use the install.sh command below, but add, right after the "install.sh", --target=/path/to/new/location. This will install at that location. If you do this, your "buildout directory" will be /path/to/new/location/sf3--everywhere in these installation instructions and in class, when told you to "go to your buildout directory", you should go here.
(Experts Only!): You can use the same Plone directory, but with a new instance in it. To do this, run the install.sh line, below. You'll get a sf3 directory in ~/Plone` for class, and you'll still have your existing instance (which is probably either ~/Plone/zinstance or ~/Plone/zeocluster. The existing instance will continue to work as before.
You should download and run the installer at:
http://tinyurl.com/3-2-1-linux
As an ordinary user (not root), extract this package, go into it, and run the installer:
$ ./install.sh --instance=sf3 --password=admin standalone
(be sure to get the case correct; the instance name and password are all lower-case)
Please use this line exactly as shown. You cannot choose a different location for buildout, use a ZEO installation, or run this as root. These options all will not work for class, and you will not be able to finish the installation instructions if you choose them.
You do not need to install Zope or Python separately, and should not do so (it's fine if your computer already has these installed; the Unified Installer setup you just made won't be using them, though).
You must install Firefox. It's fine if you to use another browser for your regular usage. We will, however, need Firefox in class.
Most Linux distributions include Firefox out of the box; if not, please install it for your distribution. Any version will do.
A fantastically useful add-on for Firefox; we'll be using this to learn to how to stylize Plone, bug fix CSS errors, etc. It's a very easy install once Firefox is set up:
http://chrispederick.com/work/webdeveloper/
In Ubuntu, you can use the firefox-webdeveloper package, instead of installing this by hand:
$ sudo apt-get install firefox-webdeveloper
Change into your "buildout directory":
$ cd ~/Plone/sf3 sf3$
Install the course script:
sf3$ ../Python-2.4/bin/easy_install
-f http://dist.plonebootcamps.com/sf3 plonebootcamps.configure
(This should be entered as one line; it splits here over two lines just because of length)
You can cut and paste this line into your terminal, if you'd prefer. Here it is on one line:
../Python-2.4/bin/easy_install -f http://dist.plonebootcamps.com/sf3 plonebootcamps.configure
Run the configuration utility:
sf3$ ../Python-2.4/bin/pbconfig sf3
Regenerating your buildout pulls down any add-on products you need and updates your software. This will take several moments, and requires Internet connectivity.
To do this enter:
sf3$ bin/buildout
You should now start up your Plone server.
sf3$ bin/instance fg
Please note that, when starting up, you'll see lots of messages on the screen, including some "INFO" messages about files not being found, or "Deprecation Warnings", etc. These are nothing to worry out.
It has started successfully when it says "Zope is ready to serve requests". This may take a few minutes. If it returns to a terminal prompt, it did not start up successfully.
It's very important to test your setup before class. The testing instructions are the same for Windows, OSX, and Linux.
Go to your web browser and view:
http://localhost:8085/dashboard
If this returns an "Failed to connect" error (or any other kind of "can't reach webserver"-type error), your Plone server has not been started. See the instructions above on starting the server.
If this returns a SiteError "Resource not found", you've installed Plone, but not our custom software (which you'll need for class). Please check the instructions again, and seek help on the mailing list.
If this returns a page headed PloneBootcamps Zope Dashboard, this was successful. Good work!
We will be using a Java-based graphical editor called "ArgoUML". It should be installed automatically by the setup instructions. However, it is possible it may not work if you don't have Java installed or if you have an old/broken Java installation.
Go into a new terminal window, and change into your "buildout directory" (using the same location as before):
$ cd ~/Plone/sf3 sf3$
Start up ArgoUML.
sf3$ bin/argouml
This should give you, after a moment, a startup dialog box for ArgoUML. If it gives you an error, or no response, you should check your Java setup, and, if necessary, install ArgoUML by hand from their site:
You can stop your server by switching to the terminal window where it is running. Press CONTROL-C to kill the process.
After class, you can uninstall all the software you've installed by simply deleting the ~/Plone/ directory (or wherever you installed this). This will clean up everything.
Problem:
When I run easy_install, I get:
[Download errors: (10061: 'Connection refused')](sometimes these also appear as "Connection Not Found" or similar errors)
Answer:
Almost certainly, you're trying this behind a corporate firewall, and Python doesn't know how to get through this firewall.
You can fix this by setting an evironmental variable with the firewall information:
Setup an environment variable "HTTP_PROXY" that points to your proxy server, of the form: user:password at server:portEasier for many people will be to just try the install from home, or a wireless cafe, where you won't have to worry about going through your firewall.
Problem:
When I run pbconfig, I get:
You either did install your Plone into the proper location, or you are not in your buildout directory.
Answer:
You did not use the --instance=sf3 part of the install.sh command when you installed Plone (or you mispelled it--capitalization counts!), and therefore it installed your instance into a folder with the wrong name.
You can re-run the installer, using the directions provided above, or you can rename the folder at ~/Plone/zinstance to ~/Plone/sf3. If you do this, you won't have to re-run the installer. You can just re-run the pbconfig command.
Note
Problems with these instructions?
Send email to the class mailing list, and hopefully one of the other students or the trainer can help out.
You will need the Buildout setup of Plone.
You can download the buildout installer at:
http://tinyurl.com/p3-2-1-osx
As an ordinary user (not root), extract this package, go into it, and run the installer.
When it runs, keep the default choices for location and installation type. Do not try to choose a different setup-- we rely on the standard setup in class.
When it prompts you for a password for your admin user, you must enter "admin" (twice, to confirm it). You can always change the password after class, if you need to.
This will create the following folder structure on disk:
/Applications
/Plone
/zinstance
Rename the folder zinstance to sf3 (all lower case). This is required for our course software.
You do not need to install Zope or Python separately, and should not do so. It's fine if you already have these installed (almost all Macs ship with Python); however, the installer you just used ignores these copies and installs its own private Python and Zope.
You must install Firefox. It's fine if you to use another browser for your regular usage. We will, however, need Firefox in class.
http://www.mozilla.com/firefox/
Any version of Firefox will do.
A fantastically useful add-on for Firefox; we'll be using this to learn to how to stylize Plone, bug fix CSS errors, etc. It's a very easy install once Firefox is set up:
http://chrispederick.com/work/webdeveloper/
Change into your "buildout directory"
$ cd /Applications/Plone/sf3 sf3$
Install the course script:
sf3$ ../Python-2.4/bin/easy_install
-f http://dist.plonebootcamps.com/sf3 plonebootcamps.configure
(This should be entered as one line; it splits here over two lines just because of length)
You can cut and paste this line into your terminal, if you'd prefer. Here it is on one line:
../Python-2.4/bin/easy_install -f http://dist.plonebootcamps.com/sf3 plonebootcamps.configure
Run the configuration utility:
sf3$ ../Python-2.4/bin/pbconfig sf3
Regenerating your buildout pulls down any add-on products you need and updates your software. This will take several moments, and requires Internet connectivity.
To do this, enter:
sf3$ bin/buildout
You should now start up your Plone server.
sf3$ bin/instance fg
Please note that, when starting up, you'll see lots of messages on the screen, including some "INFO" messages about files not being found, or "Deprecation Warnings", etc. These are nothing to worry out.
It has started successfully when it says "Zope is ready to serve requests". This may take a few minutes. If it returns to a terminal prompt, it did not start up successfully.
It's very important to test your setup before class. The testing instructions are the same for Windows, OSX, and Linux.
Go to your web browser and view:
http://localhost:8085/dashboard
If this returns an "Failed to connect" error (or any other kind of "can't reach webserver"-type error), your Plone server has not been started. See the instructions above on starting the server.
If this returns a SiteError "Resource not found", you've installed Plone, but not our custom software (which you'll need for class). Please check the instructions again, and seek help on the mailing list.
If this returns a page headed PloneBootcamps Zope Dashboard, this was successful. Good work!
We will be using a Java-based graphical editor called "ArgoUML". It should be installed automatically by the setup instructions. It typically installs fine on OSX, but it's good to check.
Go into a new terminal window, and change into your "buildout directory" (using the same location as before):
$ cd /Applications/Plone/sf3 sf3$
Start up ArgoUML.
sf3$ bin/argouml
This should give you, after a moment, a startup dialog box for ArgoUML. If it gives you an error, or no response, you should check your Java setup, and, if necessary, install ArgoUML by hand from their site:
You can stop your server by switching to the terminal window where it is running. Press CONTROL-C to kill the process.
Problem:
When I run easy_install, I get:
[Download errors: (10061: 'Connection refused')](sometimes these also appear as "Connection Not Found" or similar errors)
Answer:
Almost certainly, you're trying this behind a corporate firewall, and Python doesn't know how to get through this firewall.
You can fix this by setting an evironmental variable with the firewall information:
Setup an environment variable "HTTP_PROXY" that points to your proxy server, of the form: user:password at server:portEasier for many people will be to just try the install from home, or a wireless cafe, where you won't have to worry about going through your firewall.
Problem:
When I run pbconfig, I get:
You either did install your Plone into the proper location, or you are not in your buildout directory.
Answer:
You did not rename your zinstance folder to sf3 (or you mispelled it--capitaization counts!), as required in the instructions. Do this, then run the pbconfig command again.