Permalink
Browse files

Rewrote Readme and installation instructions in MarkDown format

  • Loading branch information...
p3k committed Jul 4, 2014
1 parent 291dafa commit fe6831bcd65d56f27728a762af77b5c93c99d5a4
Showing with 126 additions and 204 deletions.
  1. +0 −88 INSTALL
  2. +68 −0 INSTALL.md
  3. +0 −116 README
  4. +58 −0 README.md
View
88 INSTALL

This file was deleted.

Oops, something went wrong.
View
@@ -0,0 +1,68 @@
# Installation
## Helma Object Publisher
Antville needs Helma Object Publisher to be installed on the desired machine. If not already done so please [download Helma](http://helma.org/download) and follow the [installation instructions](http://helma.org/download/installation).
## SQL Database
Furthermore, Antville needs an SQL database to be installed as well. Currently supported products are PostgreSQL and MySQL. If not already done so please install the desired database before you continue.
For connecting Antville to the database the corresponding JDBC driver is also necessary. If not already done so please copy the driver to the directory `lib/ext` of Helma’s installation directory.
As of writing this installation guide the drivers could be downloaded via the following URLs:
- [http://jdbc.postgresql.org/download.html]()
- [http://dev.mysql.com/downloads/connector/j/]()
Of course you can also use a packet manager like aptitude or MacPorts if the JDBC driver is available from there. However, you then need to create a symbolic link to the driver from within Helma’s `lib/ext` directory.
Now unpack the Antville distribution package. Move the resulting directory `antville` into the directory `apps` of your Helma installation.
Inside the directory `antville` you will find a directory called `db`. This directory contains all database-related files, ie. several SQL scripts for creating the database needed by the application. Change to that directory.
Antville currently comes with scripts for PostgreSQL (`postgre.sql`) and for MySQL databases (`my.sql`).
_Note:_ Antville is preconfigured for PostgreSQL out of the box but it is easy to modify the configuration to be compatible with MySQL.
Each of these SQL scripts creates the tables, indexes and initial records and also the account used by the application to communicate with the database.
## Granting Database Access
The default password of this account is `antville`, so you should change it if you want to secure your installation. Open the desired SQL script and scroll down to the `create user` (for PostgreSQL) or `grant user` (for MySQL) statement. Search for `password` (PostgreSQL) or `identified by` (MySQL) and change the trailing value in quotes to the password of your choice.
Please refer to the documentation of your database on how to run the appropriate script. Afterwards you will have to tell Antville how it can access your database. This is done in a configuration file named `db.properties` which is located in the `code` directory, or – if you are going for MySQL – in the `db/my.compat` directory.
Open the desired file and ensure that the line beginning with `antville.url` points to the server that runs the database. By default, this is the local machine aka localhost which will be just right in most cases.
Check that the password is set accordingly to the one you entered in the SQL script and save the file.
## Enabling an Application
Finally, you need to tell Helma about the new application. This is done by adding the contents of the file `apps.properties` in the `extra` directory to the file `apps.properties` located in the top installation directory.
_Note:_ If you are using MySQL you need to edit and enable line 5 (the one defining `antville.repository.1`) of the file by removing the leading comment symbol `#`.
## Starting Up!
Now start up Helma and point your browser to
http://localhost:8080
(assuming that Helma is running on the same machine and uses port 8080).
You should see Antville’s start page where you can create a first user account that automatically has system administration rights to your Antville installation.
Have fun!
## TL;DR
1. Install Helma if not already done so
2. Install PostgreSQL or MySQL database if not already done so
3. Install corresponding JDBC driver in helma/lib/ext
4. Unpack Antville distribution file
5. Move antville directory into helma/app directory
6. Run the desired script in antville/db for either PostgreSQL or MySQL
7. Copy contents of antville/extra/apps.properties to helma/apps.properties
8. If necessary, enable MySQL compatibility in apps.properties
9. Start up Helma and browse to [http://localhost:8080/antville]()
View
116 README

This file was deleted.

Oops, something went wrong.
View
@@ -0,0 +1,58 @@
# About Antville
Antville is an open source project aimed at the development of a high performance, feature rich weblog hosting software. It can easily host up to several thousands of sites (the number of weblogs is rather limited by the installation owner’s choice and server power than by software limitations).
Antville is entirely written in JavaScript (ECMAScript, to be precise) and based on Helma Object Publisher, a powerful and fast scriptable open source web application server (which itself is written in Java). Antville works with a relational database in the backend.
[Check out the project site for more information.](http://project.antville.org)
## Status
Antville can be considered stable quality code. It is heavily used by several thousands of users at [Antville.org](http://antville.org) and [several other sites](http://code.google.com/p/antville/wiki/AntvilleSites). Nevertheless, there still could be bugs hidden somewhere in this application.
Antville can be used for production purposes, but please bear in mind that the creators of Antville do not take any warranty, whichever kind.
## System Requirements
To run Antville you need [Helma Object Publisher](http://helma.org) and a relational database in the backend. Antville was thoroughly tested with [PostgreSQL](http://postgresql.org) and [MySQL](http://mysql.com).
For setting up Helma Object Publisher and the database of your choice please refer to the corresponding installation instructions.
To enable Antville sending confirmation mails to users (e.g. after registration) you will also need access to an SMTP server.
Helma comes with its own embedded webserver (Jetty) so you do not need to install one, although you can easily use Apache httpd as front-end webserver, too.
Please refer to the Install.md file for detailed information on how to install Antville.
## Documentation and Further Information
For documentation and further information regarding Antville you can refer to:
- [project.antville.org](http://project.antville.org)
- [about.antville.org](http://about.antville.org)
- [help.antville.org](http://help.antville.org)
Feel free to ask any question about Antville at our [support site](http://help.antville.org).
You should follow Antville on [Facebook](http://facebook.com/Antville) and [Twitter](http://twitter.com/antville_org)!
## Bug Reporting and Feature Requests
If you think you found a bug [please report it](http://project.antville.org).
A good place for your feature requests or proposals is the [project development site](http://project.antville.org).
Since Antville is open-source, you are definitely encouraged to modify the application, we would be happy to hear from your ideas, suggestions and changes – drop us a message via [mail@antville.org]() or use any of the aforementioned channels.
For those of you who demonstrated a commitment to collaborative open-source development through sustained participation and contributions within the development of Antville, there will also be other ways to participate.
## About Helma Object Publisher
[Helma Object Publisher](http://helma.org) is a web application server.
With Helma Object Publisher (sometimes simply referred to as Helma or Hop) you can define Objects and map them to a relational database table. These so-called HopObjects can be created, modified and deleted using a comfortable object/container model. Hence, no manual fiddling around with database code is necessary.
HopObjects are extended JavaScript objects which can be scripted using server-side JavaScript. Beyond the common JavaScript features, Helma provides special “skin” and template functionalities which facilitate the rendering of objects via a web interface.
Thanks to Helma’s relational database mapping technology, HopObjects create a hierarchical structure, the URL space of a Helma site. The parts between slashes in a Helma URL represent HopObjects (similar to the document tree in static sites). The Helma URL space can be thought of as an analogy to the Document Object Model (DOM) in client-side JavaScript.

0 comments on commit fe6831b

Please sign in to comment.