Changes

{{outdated}}[[Category:How-To]] [[Category:Computers]] [[Category:WSO]][http://wso.williams.edu WSO's web site] is a work in progress. You can always see "the next step" at http://wso.williams.edu:3000, where the latest "stable" (stable being a relative term) version of the next update to the site lives. If you're impatient about the new facebook, or you know web design or PerlRuby, or if you just want to see how it's done, you're welcome to check out a copy of the code and go to work. This page will tell you how to get started.

==SSH Email root at wso.williams.edu to WSO==get an account and password so that you can checkout a copy of the code from our Subversion repository. You'll need this when running any of the svn commands below.

== Choose your environment == Working on the WSO site will require running your own development copy of the site. There are two basic ways to go about this. 1. Run your development server in your account on WSO's user server. This requires the following:* A WSO shell account.* A WSO subversion account.* A computer with an ssh client (ssh on *nix or Mac OS X, PuTTY on Windows).* Some familiarity with the command line.2. Run your development server on your machine. This requires the following:* A WSO subversion account.* A computer.* Familiarity with installing command line software (preferably via a package manager). Though setting up a dev server on your own machine may require more investment of time up front, it is ultimately more flexible, since you have more control over and easier access to your environment. ==Option 1: Set up a development server in your WSO account== ===SSH to WSO=== If you don't have a WSO account, email [http://root at wso.williams.edu/facebook/view?unix=06emm Evan], [http://wso.williams.edu/facebook/view?unix=07mg_2 Mike], or [http://wso.williams.edu/facebook/view?unix=06bdc Ben]. One of them will hook you up. A WSO account is not your 06abc or abc1 account. It is the first letter of your first name followed by up to seven letters of your last name. Once you have an account, go ahead and log in:

ssh username@wso.williams.edu ==Set up a web server==

This part sounds scarywhere username is your WSO username (remember, but most of the configuration has been done for you alreadynot your 06abc OIT id). First we copy the server files into your home directory:

Now we just change Once you've logged in with SSH, you're ready to check out your very own copy of the configuration files WSO code. In your home directory, or wherever you'd like to work for keep your personal accountcopy of the WSO site, run the following command to use Subversion to check out the code. Change directory into (Don't forget the dot at the end!) This will spew a whole log of output onto your new screen, listing all the files it's checking out. You can replace "webwso-devel" directory:with whatever name you want for your local copy of the code.

cd websvn checkout svn://wso.williams.edu/wso-on-rails/trunk wso-devel

Next, type these instructions EXACTLY. Note Now change directory into the back-ticks in the second command. ( ` ). The back-tick is on the key right above tab on the keyboard.code directory:

sed cd wso-i .bak "s/USER/$USER/g" apache/*.conf apache/apache_test apachectl sed -i .bak "s/UID/`expr 50000 + $UID`/g" apache/*.conf rm apache/*.bakdevel

So the mysterious second command will tell the web server what port We need to listen on. Programs listen on different ports create a log file for your site so that when it doesn't complain directly to you make a network request of WSO (SSH, the web, e-mail), it knows which program should handle the request. Your server will listen on the port number 50000 plus your user id. (That makes sure everyone has a unique port.) To find out what that is, type

expr 50000 + $UIDtouch log/development.log

''Write Now your site is ready to run! If you just want to poke around you can do that number down for laterwithout starting the server (check out [[How to transfer files to WSO]]), but if you want to make changes and see what happens, keep reading.''

==Get =Start the codeserver===

LetBut first you need your own personal port to run it on. Find this by running the following command. You's get a fresh copy ll want to save the output of the codethis for future reference. On WSO, type

svn co file:///var/svn/wsonet ~/web/wsonet If you just want to see what the code is like, you can poke around the wsonet folder. For those of you afraid of the command line, you can now look at the files by logging into WSO over SFTP. Check out the bit on SFTP at [[How to transfer files to WSO]].expr 50000 + $UID

Of courseTo start the server run the following command in the wso-devel directory, to actually work on replacing your_port with the code, you'll want to know what effects your changes havenumber we generated above. That's why we want to

==Start the /opt/local/bin/ruby script/server==-p your_port

OKIf you see something like the following, wethen you're ready to start the web serverin business. Type this:

~=> Booting Mongrel (use 'script/webserver webrick' to force WEBrick) => Rails application starting on http:/apachectl start/0.0.0.0:your_port => Call with -d to detach => Ctrl-C to shutdown server ** Starting Mongrel listening at 0.0.0.0:your_port ** Starting Rails with development environment... ** Rails loaded. ** Loading any Rails specific GemPlugins ** Signals ready. TERM => stop. USR2 => restart. INT => stop (no restart). ** Rails signals registered. HUP => reload (without restart). It might not work well. ** Mongrel available at 0.0.0.0:your_port ** Use CTRL-C to stop.

===Setting up port forwarding===

The way through the firewall is to pretend that the web server is running on your computer and not on WSO. We'll use a technology called ''port forwarding'' to send web requests to your machine ''through an SSH connection'' to your server on WSO. This is, simplyawesome, awesomeand not too hard.

ssh -N -f -2 -L 8000/localhost/53717 emiller@wsoEXCEPT instead of your_port, put the port number that you wrote down, and instead of "username", type your WSO account name.williamsUnfortunately, you'll have to run this command somewhat frequently, since SSH connections close when your computer reboots or goes to sleep (or WSO crashes, or whatever.edu..). To make this a little less tedious, open the file called .bashrc in your home directory on your own machine and add this line:

EXCEPT instead of 53717, put the port number that you wrote down, and instead of "emiller", type your WSO account name. Unfortunately, you alias wso3000='ll have to run this command somewhat frequently, since SSH connections close when your computer reboots or goes to sleep (or WSO crashes, or whateverssh -N -p 22 -f -2 -L 3000/ursula/your_port username@wso.williams..). To make this a little less tedious, open the file called .bashrc in your home directory and add this line:edu'

Again, make the substitutions for your_port and username. Close the Terminal window and open a new one. Now, if you need to establish the connection, just type "wso3000" in a terminal window. You can pick a different alias wso8000='ssh -N -f -2 -L 8000/localhost/53717 emiller@wso.williams, of course.edu'

Again, make the substitutions for your own port and username. Now, if you need to establish the connection, just type "wso8000" in a terminal window. You can pick a different alias, of course. ====Windows====

Source port: 80003000

Destination host: localhostursula Continue to the Common Instructions. == Option 2: Run on your own machine== Disclaimer: The author has done this on various flavors of *nix and on Mac OS X, but knows nothing about Windows. It is possible on Windows, but no guarantees that it will just work. Google is your friend. ===Install software=== ====With your package manager==== Using your favorite package manager, install the following: * subversion* sqlite3* ruby (1.8.6)* ruby ldap (rb-ldap 0.9.1)* ImageMagick* ruby gems, a package manager for ruby packages =====Notes=====Make sure that these appear in your $PATH. On Mac OS X Leopard, the built-in ruby comes with ruby gems installed, so you may be able to skip those two. On Tiger and earlier, use MacPorts to install all of the above (mongrel is still optional). ====With ruby gems==== Using gem install the following: * rails* RedCloth* simple-rss* sqlite3-ruby* rmagick* optional: mongrel You can install all of this with the command  gem install rails RedCloth simple-rss sqlite3-ruby mongrel -y On any *nix system or Mac OS X, you'll probably need to run this with sudo. No idea about Windows. If you have any trouble with this, post to [[Talk:WSO web development]] or email bwood at wso. ===Check out the code=== In your home directory, or wherever you'd like to keep your copy of the WSO site, run the following command to use Subversion to check out the code. This will spew a whole log of output onto your screen, listing all the files it's checking out. You can replace "wso-devel" with whatever name you want for your local copy of the code.  svn checkout svn://wso.williams.edu/wso-on-rails/trunk wso-devel Now change directory into the code directory:  cd wso-devel We need to create a log file for your site so it doesn't complain directly to you.  touch log/development.log Now your site is ready to run!  ===Start the server=== To start the server run the following command in the wso-devel directory.  script/server If you see something like the following, then you're in business. (This is what you'll see if you installed mongrel, otherwise, you'll see similar output from WEBrick, the default server.)  => Booting Mongrel (use 'script/server webrick' to force WEBrick) => Rails application starting on http://0.0.0.0:3000 => Call with -d to detach => Ctrl-C to shutdown server ** Starting Mongrel listening at 0.0.0.0:3000 ** Starting Rails with development environment... ** Rails loaded. ** Loading any Rails specific GemPlugins ** Signals ready. TERM => stop. USR2 => restart. INT => stop (no restart). ** Rails signals registered. HUP => reload (without restart). It might not work well. ** Mongrel available at 0.0.0.0:3000 ** Use CTRL-C to stop.  ==Common Instructions== ===Build your database=== The development version of the WSO site uses SQLite, a file-based database to make it easy to deploy anywhere. To create your database and setup the structure we'll need, just run  rake db:schema:load in the root directory of your copy of the code (e.g. wso-devel). ===Add yourself as a user=== Also in the root directory of your site, run  rake data:dev:addusers ===Optional: update caches=== On the production server, these scripts are run every so often to keep the info on the front page up to date. You get some pregenerated caches with the code, but if you want something more realistic, run these.  ruby script/cron/rss.rb ruby script/cron/weather.rb

===Try out the server===

'''On-campus''': Open up a web browser and point it go to "http://localhost.williams.edu:80003000/". The WSO site should show up. Congratulations!

Of course, if it doesn'''Off-campus''': On a Mac or Linux boxt work, add this line to the file /etc/hostsplease describe your problem on [[Talk:WSO web development]].

127Now, you can change a file in wso-devel, and the change will show up on your development server at this address the next time you reload the page in your browser.0Sweet.0(Some changes esp.1 localhostto controllers or libraries will require restarting the server, but it's simple.williams.edu)

Of course, if it doesnIt't work, please describe s a good idea to run an update every so often so that your problem on [[Talk:How to hack on the WSO site]]local working copy picks up changes that other people have made.Change directory into your wso-devel directory and run

[http://Email root at wso.williams.edu/facebook/view?unix=06cks Kai] is the webmaster. Contact him if you'd like to change the WSO site, add a new service, or fix a bug. If he gives you get the go-ahead, you're in good shape, so go to work. Once you think your change is ready for the world, you'll need to get permission to commit add your changes to our code repository, where it will be tested and deployed. Email [http://root at wso.williams.edu/facebook/view?unix=06emm Evan] about that. HeThey'll take care of you.