antville/antville
antville/antville
1
1
Fork 0
Code Issues 51 Pull requests 8 Projects Releases 9 Wiki Activity Actions

chg: edited wording, revised or removed some outdated sections

Browse source
This commit is contained in:
Tobi Schäfer 2020-04-03 16:55:03 +02:00
parent 6427aaf9ce
commit 37817b382f
2 changed files with 21 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
INSTALL.md
View file

@ -2,18 +2,19 @@
## Helma Object Publisher ## 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). Antville needs Helma Object Publisher to be installed on the desired machine. If not already done so please [download Helma](https://github.com/antville/helma/releases) and follow the [installation instructions](https://github.com/antville/helma/#how-to-helma).
## SQL Database ## 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. Furthermore, Antville needs an SQL database to be installed as well. Currently supported products are PostgreSQL and MySQL/MariaDB. Be sure to 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. Finally, you need the corresponding JDBC driver for connecting Antville to the database. 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: As of writing this installation guide the drivers can be downloaded via the following URLs:
- <http://jdbc.postgresql.org/download.html> - <http://jdbc.postgresql.org/download.html>
- <http://dev.mysql.com/downloads/connector/j/> - <http://dev.mysql.com/downloads/connector/j/>
- <https://mariadb.com/kb/en/mariadb-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. 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.
@ -21,9 +22,9 @@ Now unpack the Antville distribution package. Move the resulting directory `antv
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. 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`). Antville currently comes with scripts for PostgreSQL (`postgre.sql`) and for MySQL/MariaDB 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. _Note:_ Antville is preconfigured for PostgreSQL out of the box but it is easy to modify the configuration to be compatible with MySQL/MariaDB.
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. 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.
@ -31,7 +32,7 @@ Each of these SQL scripts creates the tables, indexes and initial records and al
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. 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. 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/MariaDB – 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. 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.
@ -39,9 +40,9 @@ Check that the password is set accordingly to the one you entered in the SQL scr
## Enabling an Application ## 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. Finally, you need to tell Helma about the new application. This is done by adding the contents of the file `apps.properties` in the `tools/config` 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 `#`. _Note:_ If you are using MySQL/MariaDB 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 ## Starting Up
@ -58,11 +59,11 @@ Have fun!
## TL;DR ## TL;DR
1. Install Helma if not already done so 1. Install Helma if not already done so
2. Install PostgreSQL or MySQL database if not already done so 2. Install PostgreSQL or MySQL/MariaDB database if not already done so
3. Install corresponding JDBC driver in helma/lib/ext 3. Install or symlink corresponding JDBC driver in helma/lib/ext
4. Unpack Antville distribution file 4. Unpack Antville distribution file
5. Move antville directory into helma/app directory 5. Move antville directory into helma/app directory
6. Run the desired script in antville/db for either PostgreSQL or MySQL 6. Run the desired SQL script in antville/db for either PostgreSQL or MySQL/MariaDB
7. Copy contents of antville/extra/apps.properties to helma/apps.properties 7. Copy contents of antville/tools/config/apps.properties to helma/apps.properties
8. If necessary, enable MySQL compatibility in apps.properties 8. If necessary, enable MySQL/MariaDB compatibility in apps.properties
9. Start up Helma and browse to <http://localhost:8080/antville> 9. Start up Helma and browse to <http://localhost:8080/antville>

12
README.md
View file

@ -8,21 +8,23 @@ Antville is entirely written in JavaScript (ECMAScript, to be precise) and based
## Status ## 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 considered stable quality code. It is being used by several thousands of users at [Antville.org](http://antville.org) for a long time.
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. 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 ## 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). 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) – [MariaDB](https://mariadb.com) should work, too.
For setting up Helma Object Publisher and the database of your choice please refer to the corresponding installation instructions. 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. 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. Helma comes with its own embedded webserver (Jetty) so you do not need to install one, although you can easily use most popular webservers, too.
Please refer to the Install.md file for detailed information on how to install Antville. Please refer to the `INSTALL.md` file for detailed information on how to install Antville.
## Documentation and Further Information ## Documentation and Further Information
@ -44,8 +46,6 @@ A good place for your feature requests or proposals is the [project development
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. 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 ## About Helma Object Publisher
[Helma Object Publisher](http://helma.org) is a web application server driven by Java and programmed with JavaScript. [Helma Object Publisher](http://helma.org) is a web application server driven by Java and programmed with JavaScript.