Permalink
Browse files

note about how to run without vhosts

  • Loading branch information...
1 parent 037942e commit 33d3851a2d58dbfc79f2efd79f7c17908ca1e395 @jchris jchris committed Aug 13, 2010
Showing with 15 additions and 0 deletions.
  1. +15 −0 README.md
View
@@ -2,6 +2,20 @@
I was tired of all the complicated wikis that required some kind of application server that I didn't want to even think about, so I wrote a CouchApp wiki. This one uses Markdown.
+## Installing
+
+Follow the instructions below ("Deploying...") to get this code into your CouchDB. This section concerns how to make it so Pages is accessible at the URL-style you prefer.
+
+### The Easy Way (Ugly URLs)
+
+The easy way is just to run `couchapp push` as detailed below, and go to the URL it hints you. That should be something like:
+
+ http://localhost:5984/pages/_design/pages/_rewrite/page/index
+
+Now you can create your first wiki page. Later on, you can easily follow the next set of instructions to get nicer looking URLs. The nice ones will replace `/pages/_design/pages/_rewrite/page/index` with just `/page/index`.
+
+### Pretty URLs
+
To deploy this you need to point a DNS name at your Couch (or use `/etc/hosts`), and then configure your CouchDB to have a vhost like:
[vhosts]
@@ -15,6 +29,7 @@ This app requires that it be deployed to a database called `pages`. I'd like to
Once you have it deployed, visit `http://mydnsname.com:5984` and it will take it from there.
+
## Generated by CouchApp
CouchApps are web applications which can be served directly from [CouchDB](http://couchdb.apache.org). This gives them the nice property of replicating just like any other data stored in CouchDB. They are also simple to write as they can use the built-in jQuery libraries and plugins that ship with CouchDB.

0 comments on commit 33d3851

Please sign in to comment.