search

wimleers / fileconveyor

File Conveyor is a daemon written in Python to detect, process and sync files. In particular, it's designed to sync files to CDNs. Amazon S3 and Rackspace Cloud Files, as well as any Origin Pull or (S)FTP Push CDN, are supported. Originally written for my bachelor thesis at Hasselt University in Belgium.
https://wimleers.com/fileconveyor
The Unlicense
341 stars 95 forks source link

Please post useful config.xml examples #93

Open j0rd opened 13 years ago

j0rd commented 13 years ago

Currently there's no good examples in the config.sample.xml . I have to dig around in issues queues on Drupal and GitHub in order to figure things out.

If you want wider adoption you need to provide various verbose examples, (hopefully with additional comments in the XML) so that users can easily install this on their systems.

path="" needs to be explained properly. I had no idea what this did until I uploaded my files and noticed they were going under a sub folder.

The Google Closure compiler and YUI processors shouldn't really be added to the same processor chain. It would make sense to break those out using YUI Compiler for sites/default/files/css and Google Closure for sites/default/files/js . This makes sense and those who want to simply use YUI Compiler, can use it for the JS folder as well. Perhaps leave it in there, but commented out by default.

S3 and other server provider examples should be provided, along with the variables needed to use these. It takes a bit of digging around docs and finding sample configs to figure it out currently. Ideally one server for each provider would be provided in the sample config and explained.

An explanation needs to get added of the source variables like documentRoot and basePath. Currently my link updater isn't working because I don't have these set right and it's hard to find information on what they should be set to.

I'm just posting my experience with attempting to configure this module and the problems I ran into. I know the answer is RTFM, but with a couple minutes work a nice self documenting config.sample.xml could be created and save a lot of people a lot of time and it would lower the barrier to entry and provide wider adoption.

ghost commented 12 years ago

Here is mine https://gist.github.com/2909617

ghost commented 12 years ago

Here's @rjbrown99's : https://github.com/wimleers/fileconveyor/issues/2#issuecomment-64567