Fetching contributors…
Cannot retrieve contributors at this time
123 lines (82 sloc) 3.86 KB
# Installing Links
Links requires OCaml 4.04.0. We recommend installing Links using the
OPAM tool, available from:
First run the following command to install the required version of
OCaml 4.04.0 and activate it for use in the current shell session:
$ opam switch 4.04.0
$ eval `opam config env`
If you wish to use Links' database functionality, you should first
install PostgreSQL, the supported DBMS.
You can then install Links simply by issuing the command:
$ opam install postgresql links
Alternatively, if you don't have PostgreSQL installed then do:
$ opam install links
This will put Links and its files into your OPAM switch, typically
located at $HOME/.opam/SWITCH_VERSION, where $HOME is your home
directory and SWITCH_VERSION is the compiler version that you're using
(eg. 4.04.0). Links files install to several locations inside an OPAM
* The executable is called `linx` and goes into `bin`
* The Links prelude and JavaScript libraries go into `lib/links`
* The example Links programs go into `share/links`
* Links configuration file goes into `etc/links`
# Running Links.
Beginning with the Gorgie (0.6) release, Links supports two methods of running
applications: either via the standalone application server, or via the CGI
interpreter used in previous releases. The executable name is `linx`.
## Application Server
# Examples (without a database)
To run the examples that don't use the database with the Links
application server go into share/links directory inside your OPAM
switch and invoke the following command:
linx -m --path=examples:examples/games
(This version just displays the source code for examples that use the
The default port is 8080, so you should now be able to access the
examples by pointing your browser at:
# Examples (with a database)
To run the examples using the Links application server go into
share/links directory inside your OPAM switch and invoke the following
linx -m
* The -m flag enables support for Links' module system, new in Gorgie.
* The --path flag says that files can be found in the following directories:
- examples
- examples/games
- examples/dictionary
* Finally examples/webserver/examples.links is the file to run, which imports
the example modules and sets up the application server.
But first you need to do a few things.
1) By default Links uses a config file inside etc/links directory. Use
--config=/custom/config/file flag to use a different configuration file.
2) The default config file should contain paths to JavaScript libraries:
Where SWITCH_PATH is the actual path on your system. To use
database examples you need to add a database configuration to the
config file:
The database user fred should exist. With postgres, perhaps the
easiest way to do this is to tie fred to your unix username and
then no separate authentication is required.
3) Create appropriate databases. If you are using postgres and you
have tied your username to the database as described in 2) then you
can use the scripts in examples/dbsetup.
cd examples/dbsetup
Otherwise you can adapt them to your particular database set up.
Postgresl data dumps for the larger databases (citations and
dictionary) can be obtained from a separate repository:
## Documentation
Some (outdated) documentation can be built by running the Makefile in
the doc directory.
Some very incomplete documentation is available on the links wiki: