|Last updated: 8/20/2002; 9:32:53 AM|
Marketing 101. Consulting 101. PHP Consulting. Random geeky stuff. I Blog Therefore I Am.Radio UserLand RCS Step by Step and FAQ
Radio UserLand RCS Step by Step and FAQ
J. Scott Johnson, Guy K. Haas
This is a draft document. Its a work in progress, it isn't complete. I'm still working on it.
Please send suggestions, comments and flames to firstname.lastname@example.org. The Table of contents lists the intended content. If an item on the Table of Contents isn't linked then its just not written yet.
DISCLAIMER: This document, while not Macintosh hostile, is written from the perspective of a Windows user and the examples reflect this. Please direct the obligatory violent, hostile platform flames to email@example.com. Note: I also have an iMac too.
Table of Contents
The following topics are covered in this document:
- Understanding RCS – What is It?
- How to Build an Extranet with your Cable Modem, Radio and RCS
- Day to Day Use
- Platform Issues: Macs and PCs
- How do I create my Weblog?
- Letting Others Create Their Own Weblog
- Using Categories to Segment Your Weblog for Different Types of Readers
- Using Stories for Long Documents
- Adding Pictures to Your Radio Documents
- Applying News within the Firewall
- Publishing Office Documents, Word, Etc through Radio
- Using a Weblog as a Daily Knowledge Management Tool
- Using a Weblog to Communicate with Clients
- How do I maintain a public weblog at radio.weblogs.com and a weblog on my copy of RCS?
- Maintenance and Support
- Restricting Radio / RCS to within Your Firewall
What is It?
Radio RCS is an add-on product for the Radio UserLand weblogging system. It adds the following features:
- Local operation within your own firewall
- Operate either as a way to create a single weblog read within your organization or as a tool to support multiple end user weblogs within your organization
- Allow a single desktop machine to support multiple end user weblogs
At its core, Radio produces a regularly updated web page, a weblog. Weblogs can cover any topic imaginable and do. Take a look at www.weblogs.com for more.
If you already are a Radio user then the best way to think of RCS is "radio.weblogs.com/myownsetofusernums" within your own firewall. In other words, with RCS,
When you download RCS, if you aren't a long term Radio user, your first reaction may be "Huh!" or "Where's the actual program?" RCS is contained entirely within a single file, Radio.root, which you install by downloading and copying to your Tools folder. Its not a normal .EXE program or Windows service which is what you were probably expecting. Here's why: .root files are programs to Radio. Inside Radio are, at a minimum, the following components:
- A sophisticated scripting language called UserTalk
- An object database
- A scheduler
- A network engine that speaks TCP/IP, HTTP, FTP, SMTP, RSS and other Internet protocols
RCS is an application that is built on top of Radio as a native "radio application". It is actually written in UserTalk and does its magic through Radio's scheduler and network engine.
Who are you? Why do you care?
I'm an avid weblogger, programmer and I offer commercial services for Radio / RCS including comprehensive technical support. I also spent 3 1/2 years designing and implementing enterprise Knowledge Management software so I know Knowledge Management like the back of my hand. Weblogs and Radio/RCS are a next generation knowledge capture tool and hugely interesting to me. My KM software was from Dataware, a company which is now defunct, so I have archived the product literature here.
What Else Should I Read?
If you are a new Radio user, there is a lot to read. Here are some places to start:
Licensing: How Many Copies Do I Need to Buy?
At the present time, RCS is actually free. UserLand has released it to spread the Radio word and drive weblog based Knowledge Management within the firewall. So, the question is not, how many copies of RCS you need to buy, but how many copies of Radio you need to but. That's simple: one per weblog author. If you are running RCS to disseminate a single internal weblog then you need only one copy of Radio. If you start having additional internal weblogs (say, one per project team, written by the team lead) then you need n copies of radio where n is number of internal weblogs.
NOTE: I'm am asking UserLand to review this answer specifically to make sure that it is correct.
The first step is to decide where RCS is going to run. RCS is actually a server product that can operate on your desktop as well. For example, you could install RCS on a dedicated server or on your desktop machine. Either way will work but for a server application, you want it always available. If your desktop is frequently rebooted then this would be bad since it would make your weblog unavailable.
Here are the basic installation steps.
- Install Radio first. Even if you aren't weblogging on that machine (for example, you are installing RCS on a server machine), Radio needs to be there.
- Download RCS from UserLand. Save it into the program filesRadio UserLandTools directory on the machine where you want to install it.
- Go into Radio ON THAT MACHINE and select the Tools link from the command bar.
Example: Radio on a Server
Let's say that you have Radio on your desktop and Radio / RCS on a server. What you want to do is go that machine's IP address or network name and then into Radio.
Your machine is http://192.168.1.43/ and your server is http://192.168.1.90/ then you want to go to: http://192.168.1.90:5335/ or http://192.168.1.90/ to configure RCS via the Tools link. The reason that two links are stated is that the port Radio runs on can be configured differently. These are the two normal options.
Further configuration is covered below under "Configuration". This can be a bit complicated so it has its own section.
Guy, I need some help here. Do you still have your notes?
IMPORTANT: Put Radio in Startup!
Whether or not you run Radio on your machine or on a server, you want to definitely put Radio in that machine's Startup folder! If you don't and that machine is rebooted then your weblog will be unavailable.
How to Build an Extranet with your Cable Modem, Radio and RCS
Day to Day Use
Platform Issues: Macs and PCs
How do I create my Weblog?
A good overview of this is here.
Letting Others Create Their Own Weblog
Using Categories to Segment Your Application
Using Stories for Long Documents
Adding Pictures to Your Radio Documents
Publishing Office Documents, Word, Etc through Radio
Using a Weblog as a Daily Knowledge Management Tool
Using a Weblog to Communicate with Clients
How do I maintain a public weblog at radio.weblogs.com and a weblog on my copy of RCS?
The answer here is pretty simple: Two separate computers. I'm not actually joking here. Radio simply isn't to produce two separate weblogs targeted at different destinations. Yes, you could, perhaps, make it work. I wouldn't recommend it. My solution was to use my desktop to run the copy of Radio / RCS that maintains my client weblogs and to use my laptop to run the copy of Radio that I use for radio.weblogs.com.
NOTE: I can still do all my authoring from one machine, my desktop with the nice keyboard, by just going to the IP address of whichever machine I want to publish from.
Maintenance / Support
When you are publishing a personal weblog, maintenance isn't a big deal. If you are doing it internally, it's a huge issue. In this section, I have outlined most of the major maintenance issues from technical support through backups and event logging..
How do I get technical support?
Support on Radio from UserLand is available through their discussion forum, http://radio.userland.com/discuss/. No phone support or additional support plans are currently available.
Are there additional support options available?
As a service of The Radio Works, I offer extended support plans for internal Radio / RCS use. Please see the home page for The Radio Works.
How do I back it up?
To back up Radio /RCS, you want to regularly backup the following directories and files:
- program filesRadio UserLand*.root
- program filesRadio UserLandTools*.root
- program filesRadio UserLandwww*.*
The .root files are the underlying Radio object database and program code. Think of this as a Registry file or .INI file on steroids. Just as one of these files can get corrupted at times and need to be restored, so can a .root file. My recommendation is that you back these up and keep the past two weeks or so available. I've never had a corruption problem but I don't believe in playing fast and loose with backups and neither should you.
All user data for Radio / RCS is stored in the www directory. Specifically there is a users directory where the weblogs for each user is stored according to their Usernum.
Can I get a list of Usernums?
When you start dealing with backup and there is more than one weblog on the machine running RCS, you will quickly learn about "Usernums". The way that RCS operates is that a user running Radio "publishes" their weblog to RCS. This process, also called upstreaming, takes the content of the user's weblog and moves it to the RCS machine as static HTML and image files. This approach, which deliberately avoids dynamic content, very intelligently maximizes performance so that even a low end machine can serve hundreds if not thousands of users. Each user's weblog is stored in the directory program filesradio userlandwwwusernum directory where "usernum" is the number of the user. These are zero padded numbers, seven digits long. For example, your first usernum is "0000001" which has a directory of program filesradio userlandwww0000001.
At present time there doesn't seem to be a way to generate a list of usernums to human names or email addresses. I am working on a utility for this and please contact me at firstname.lastname@example.org if you need this feature.
If you have ever used the Windows Event Viewer then Radio's Events feature will make you feel right at home. Events logs everything that Radio does in an easy to understand list that you can periodically example. A picture is shown below.
The following items are described for every event:
What Events are there?
The following system level events appear in the event log:
- Update Themes. Every night Radio looks for new look and feel templates or themes as they are called and saves them to your system if they are available.
- Please notify. The meaning of this is unclear at the present time.
- Hourly scan. Every hour, Radio looks for new feed items based on the news feeds to which you subscribe.
- Upstream. The process of moving information up to your RCS server.
- Weblogs. The process of notifying www.weblogs.com that your server has an updated weblog. If you are running within your firewall, even if you see this event, no one can get into your firewall so you don't need to worry (unless, of course, your weblog is extranet accessible in which case you should worry).
- Glossary read. The glossary is a core component of Radio which is regularly updated.
- Hot List. The hotlist of the top 100 most subscribed to weblogs is regularly loaded.
- Nightly update. Every night Radio will update itself looking for the latest code.
What is this Nightly Update?
The bulk of Radio / RCS exists in the files Radio.root and RadioCommunityServer.root. Every night these files are updated. In an internal corporate application, this may not be acceptable i.e. what if the update has bugs and takes down our internal Knowledge Management weblog? This can be configured on the Prefs page as described below under "Restricting Radio / RCS to within Your Firewall". If you want the updates but also the equivalent of a "radio condom" then a work around is to use an automated tool like SecondCopy which, on a schedule basis, can archive (zip format) specified files such as the .root files. This has worked quite well for me.
What type of reporting is in RCS?
RCS can be configured to deliver an hourly report as shown below:
Hourly status report for Radio Community Server.
Server: 18.104.22.168 (192.168.1.100).
0 subscriptions deleted in the last hour, 0 subscriptions remaining.
In the last hour, 0 files were upstreamed, combined size: 0K.
There are 1 signed on users, out of a total of 4 users.
Number of users who have upstreamed at least once: 4.
Number of users who have upstreamed at least 10 times: 4.
Number of new users in the last hour: 0.
4/14/2002; 7:00:01 AM
As with any reporting tool, you need to read it regularly to make sure that problems do not get ignored.
Restricting Radio / RCS to within Your Firewall
A huge concern of corporate users is restricting Radio / RCS so that your internal information never leaves the firewall. There are two ways to handle this. Each is documented below.
Setting Radio and RCS Prefs
There are two separate issues, incoming data and outgoing data. Incoming data refers to things like news feeds, themes and updates. Outgoing data is where Radio does something like updating www.weblogs.com that your weblog has changed.
To turn off incoming and outgoing data, use the following steps in Radio itself:
Turn off all News Feeds by going to the News link on the Radio command bar and deleting any News Feeds to which you have subscribed.
Go into the Prefs page by going to the Prefs link on the Radio command bar and follow the link "Participate in the Weblogs.com Community". Turn off the checkbox on this screen and click the submit button.
Go into the Prefs page by going to the Prefs link on the Radio command bar and follow the link "Remote Access and Security". For maximum security, turn off all checkboxes and click the Submit button. Otherwise use good judgement.
Go into the Prefs page by going to the Prefs link on the Radio command bar and follow the link "Periodic Updates". For maximum security, turn off all checkboxes and click the Submit button. Otherwise use good judgement.
Go into the Prefs page by going to the Prefs link on the Radio command bar and follow the link "Event Logging". For maximum security, turn ON all checkboxes. This gives maximum logging which is always a good idea.
Go into the Prefs page by going to the Prefs link on the Radio command bar and follow the link "XML-RPC and SOAP in Radio". For maximum security, turn off the option "Check this box to allow incoming XML-RPC and SOAP messages." You could also limit the messages to only coming from the loopback address 127.0.0.1 or localhost.
Go into the Prefs page by going to the Prefs link on the Radio command bar and follow the link "The Blogger API in Radio". For maximum security, turn off this option.
Go into the Prefs page by going to the Prefs link on the Radio command bar and follow the link "Enable the Aggregator". Turn this option off. Yes, I did have you turn off all news feeds earlier. This is a "belt and suspenders" step.
Go into the Prefs page by going to the Prefs link on the Radio command bar and follow the link "Scan on Startup". Turn this option off. Yes, I did have you turn off all news feeds and the aggregator earlier. This is, again, a "belt and suspenders" step. Additionally, I would personally turn off all News related options, but that's just my own paranoid self.
Go into the Prefs page by going to the Prefs link on the Radio command bar and follow the link "Upstream directory.opml". Turn this option off.
Once you have configured Radio as talked about above, you need to configure RCS with similar settings. This is shown below.
Modifying Radio.root, RadioCommunityServer.Root and RadioCommunityServerData.Root
I'd like to thank several people for making this FAQ possible:
Dave Winer for making a product good enough for third parties to write documentation for free
Russ Lipton whose Radio Tutorials taught me a lot
Jenny the Shifted Librarian who made Navigator Links clear for the first time
Guy Haas, Software Exegete in Silicon Valley who helped a lot
The makers of WinAmp, Diet Coke, Dunkin Donuts and Krispy Kreme
Special thanks to Guy Haas who edited large parts of this, without request, fixing several egregious errors that I made. Any errors in this document are, of course, my own and I take full responsibility for them. Punishment by lashes with a wet noodle or flaming emails happily accepted.
Distribution of this Document
Can I distribute this?
Yes. Please feel free to distribute this or link to it provided that it is complete (including what's just below) and that the copyright notice is intact. Thanks.
The Radio Community Server
Where do I download it?
Where's the FAQ for RCS?
Take a look here: http://rcs.userland.com/frequentlyAskedQuestions
Download it from the url above. When you have to save the file, select that you want to save it into the program filesradio userlandtools directory.
How do I set the port where Radio runs?
In installing RCS, you may well have to modify the port where the Radio application runs. This is done as follows:
- Go into the main Radio environment (Right click on the Radio icon in your lower right task bar area and then choose Open Radio).
- Select From the Radio menu "Web Server".
- Select from this menu "Set Port". Enter the port that you want to use.
Common ports that you might want to use are: 80 (the default port for web servers, you can only use this if there ISN'T a web server on the machine already or if its not running on port 80), 5335 (Radio's default port when 80 is used) and 8080 (Radio's second default port).
NOTE – If you need to do this then you may also need to disable a port. Here's a quote: "In the radioStartupCommands.txt in the Radio UserLand folder, you can add this command to disable port 5335:
user.inetd.config.http2.startup = false;" Read Original.
Understanding the Full Peer Concept
This is interesting. Take a look here: http://www.userland.com/whatIsAFullPeer
How do I reset my default browser in Radio?
note – this actually goes somewhere else in this FAQ.
Now, to the questions …
And there's more:
Radio is a sophisticated product but even advanced stuff isn't all that hard. A lot of it is just taking advantage of the fact that what Radio produces is just a web page and all the standard tricks that you know for web pages are applicable to Radio.
How do I make my weblog automatically update the user's screen every few minutes?
This is also known as the "I want to be just like Dave feature". If you have ever read the www.scripting.com weblog, you may have noticed that if you leave it open on your desktop, periodically there will be new content. This is actually a simple HTML trick, not a sophisticated Radio thing. What you need to do is take the HTML below and insert it into the Template for your home page.
<meta http-equiv="refresh" content="6000; url=/">
Here are the steps in your copy of Radio:
Click on the Prefs link in the command bar at the top of the screen
Scroll down to Templates
Select Home page template
In the editing box, put your cursor after the first <HEAD> tag
Press ENTER to add a blank line.
Add this line by pasting it in.
Visit your page on radio.weblogs.com (or your own server) and verify that its in the page by Viewing the Source.
How do I make my weblog searchable?
You'd be surprised how quickly content on your weblog adds up. A post here, a post there and pretty soon you have lots of posts. Now you need a search engine. Or so I think. A lot of webloggers would disagree. They're wrong.
Any of the different free web search engines can make your weblog searchable. I chose www.atomz.com since I think they are really great. Sign up for Atomz (its free) and they'll end up giving you html like that shown below (don't use this since its for my site, not yours!):
<!– Atomz Search HTML for FuzzyStuff Weblog –>
<form method="get" action="http://search.atomz.com/search/">
<B>Search:</B> <input size=15 name="sp-q"><input type=submit value=Search>
<input type=hidden name="sp-a" value="sp1001f48f">
<input type=hidden name="sp-f" value="iso-8859-1">
You can add this to your home page in the same way that we added the refresh tag above only we need to put it in a different place. Here are the steps:
Click on the Prefs link in the command bar at the top of the screen
Scroll down to Templates
Select Home page template
In the editing box, scroll down to where you want it.
NOTE: This does require at least a basic understanding of HTML. To make it easy, lets assume that you want it at the top of the page.
To figure out where the top of the page is, you have to find it among all the HTML tags. What you are looking for is: <%bodytext%> . This is a Radio macro which tells Radio where the text of your web log posting should be inserted. If you are using Internet Explorer then you can press CTRL+F and search for it. If not, you'll have to scroll down and look for it.
Paste in the search form you got from Atomz in at this spot and click the Submit button.
Check out your weblog on radio.weblogs.com (or your own server) to see if the search box is ok. You may need to go back and forth playing with the HTML to get it looking just right. That's normal.
|Copyright 2002 © The FuzzyStuff|
Posted In: #blogging