Need tutorial and reference for daemon's config.xml
dkruglyak - May 22, 2009 - 11:34
| Project: | CDN integration |
| Version: | 6.x-1.x-dev |
| Component: | Documentation |
| Category: | task |
| Priority: | critical |
| Assigned: | Unassigned |
| Status: | closed |
Jump to:
Description
Existing documentation does not explain behavior of every XML attribute and option available.
Running this daemon could have significant performance and cause filesystem corruption, so its setup should not be left up for experimentation. We need an in-depth manual describing every configuration setting and its specific processing / behaviors.
Additional specific questions, that should be included with examples / tutorials:
1) How to set up / configure CSS URL rewriting
2) How to obfuscate and compress file paths (e.g. turn /site/SECRET_DOMAIN/files/SECRET_FILE.png into /zxcv1234.png)
3) How to set up and troubleshoot S3/CloudFront upload
P.S. The issue should be tagged to 6.x version, but it not yet available in dropdown.
#1
Ok, you're the second to mention that 6.x is not yet available in the dropdown, so it's a d.o permission problem, because I can see it. I'll contact the d.o admins.
I simply don't have the time to write extensive tutorials. But I did write in detail about all aspects of the daemon in my bachelor thesis text, so please look at that instead. You can get it here: http://wimleers.com/blog/bachelor-thesis-finished.
1) Simply add the
link_updater.CSSURLUpdaterprocessor to the processor chain. This is documented.2) You'll have to write a new processor for that. I'd suggest you look at
processor/unique_filename.pyas an example. This is documented in API.txt.3) Ugh, this is also documented in README.txt.
Read the docs please!
#2
If tutorial is an overkill, how about just writing a quick reference clearly explaining what every option means?
config.xml syntax is anything but obvious. What is source name, scan path and document root? What is the point of having different server URL and location? What is the syntax of filter paths, they are relative to what? I can go on about every tag/option. The config is as confusing as they come.
There is not much helpful info in your posts about thesis. For the moment, the Advanced option and the daemon are unusable.
#3
OK, I found some info inside your thesis PDF file but really this should be turned into actual module documentation.
#4
Yes, it should be, but I can only do as much as I have time to do.
And the configuration file *does* speak for itself. I've tested this with several people to whom I didn't explain anything, I just gave them the config file and asked "does this make sense"? Just spend 10 minutes looking at it, trying to associate things, and it should all start to make sense :)
#5
What python version does your script require? I have 2.4.3 and while starting arbitrator.py get "No module named sqlite3" error. I did some searching that indicates that sqlite3 is built-in with Python 2.5 and may not even exist in the same form in earlier versions.
Do you use any 2.5 specific functionality? There should be support for at least 2.4 since it is built-in with CentOS and is dependency of system scripts.
#6
Ah damn, *that* is something I should have mentioned! It requires Python 2.5, which I chose because it is by far the most commonly installed version of Python right now.
2.4 is *not * supported and will not be supported. Just install Python 2.5 and it'll be available from the command line as
python25instead of justpython. It can coexist perfectly with other versions of Python. I know, because I've got 2.6 running alongside 2.5 on OS X.I've clarified INSTALL.txt: http://websvn.wimleers.com/comp.php?repname=Bachelor+thesis&path=%2F&.
#7