Home | Download | Installation | Configuration | Usage | Help | Demo

Installation

Binary installation steps
Source installation steps (with Lighttpd)
Source installation (without Lighttpd)
Updating
Backing up Sqwee

Binary Installation

What you will need to have installed already:

1. Ruby

What to do:

1. Download binary package from here
   
   Note that Sqwee will run from wherever it is downloaded. It can be moved later, too, if you'd like.
2. Decompress the file:
   tar -zxf sqwee-lighttpd-bin-0.2.2.tar.gz
3. Change to the new directory:
   cd sqwee-lighttpd-bin-0.2.2
   
   You may wish to change the name of the directory later, which is fine.
4. Run the startup script:
   ./start_server
5. Point your favorite web browser to localhost:8000.
6. Check out how to configure Sqwee the way you want it.

Source Installation (with Lighttpd)

What you will need to have installed already:

1. Ruby
2. Rake*
3. GCC and friends**
4. Make**
5. libprce**

What to do:

1. Download the source Lighttpd package from here
2. Decompress the file:
   tar -zxf sqwee-lighttpd-src-0.2.2.tar.gz
3. Change to the new directory:
   cd sqwee-lighttpd-src-0.2.2
   
   You may wish to change the name of the directory later, which is fine.
4. Run the setup script:
   ruby setup.rb
   
   Note that nothing is actually installed, everything is built in the current directory.
5. Run the startup script:
   ./start_server
6. Point your favorite web browser to localhost:8000.
7. If everything is working, you can delete the src/ directory and the setup.rb file:
   rm -rf src/
rm setup.rb
8. Check out how to configure Sqwee the way you want it.

Source Installation (without Lighttpd)

What you will need to have installed already:

1. Ruby
2. eruby
3. SuperRedCloth
4. A webserver...like Lighttpd, Mongrel, Apache, etc.

What do to:

1. Download the source Lighttpd package from here
2. Decompress the file:
   tar -zxf sqwee-src-0.2.2.tar.gz
3. Move the directory somewhere where your webserver can serve it up. For example:
   mv sqwee-src-0.2.2 /var/www/html/sqwee
4. Make sure your webserver can serve up .rhtml files using eruby. This will vary.
5. Copy superredcloth.rb and superredcloth_scan.so to the extlib/ directory. If you built SuperRedCloth yourself, these are the only two files you'll need. You can delete the rest if you want.
6. Try visiting your Sqwee site. You are likely to get an error like:
   
   no such file to load -- ./config/config.rb (LoadError)
   
   If you do, then you need to set the $PATH variable in index.rhtml. This is from the directory where eruby is located to the directory where index.rhtml is located.
   For example, if you have the following file structure:

   				-www
   				 |
   				 --cgi-bin
   			         | | 
   				 | --eruby
   				 |
   				 --sqwee
   				   |
   				   --index.rhtml
   					

   Then your $PATH variable should be set to: '../sqwee/' (Trailing slash optional)
7. If the Sqwee default page is loading correctly, try editing and saving it. If you get an error like
   
   ../sqwee//lib/save.rhtml:24:in `require': no such file to load -- ../sqwee//extlib/superredcloth (LoadError)
   
   Then Sqwee is having trouble finding the SuperRedCloth files. Either place them in the 'extlib' directory or else you will need to change 'lib/save.rhtml' to point to their location.
8. If editing and saving is working, you should be all set.
   Now you can check out how to configure Sqwee the way you want it.

Updating Sqwee

Since Sqwee pages are saved simply as text and HTML, updating your current Sqwee installation is fairly easy. Just copy the entire /storage directory to somewhere else temporarily, install the new version of Sqwee, and copy the contents of your /storage directory back. You can overwrite anything in there, though Sqwee does need the 'nav' and 'Index' pages to function properly.

Backing Up Sqwee

If you would like to keep a backup version of your Sqwee pages, all you need to do is copy the /storage directory. If also have customized any themes or configurations, you may wish to copy those as well.