Skip to content

Commit 9de7447

Browse files
committed
docs: INSTALL.rst update
1 parent a913f1d commit 9de7447

File tree

1 file changed

+31
-12
lines changed

1 file changed

+31
-12
lines changed

INSTALL.rst

+31-12
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,45 @@
11
..
22
This file is part of Invenio.
3-
Copyright (C) 2015-2018 CERN.
3+
Copyright (C) 2015-2019 CERN.
44
55
Invenio is free software; you can redistribute it and/or modify it
66
under the terms of the MIT License; see LICENSE file for more details.
77

88
Installation
99
============
1010

11-
The best way to get an Invenio demo instance up and running immediately is by
12-
using Docker or Vagrant, for example:
11+
Please see our quick start guide on
12+
https://invenio.readthedocs.io/en/latest/quickstart/index.html
13+
14+
1. Scaffold
15+
-----------
1316

1417
.. code-block:: console
1518
16-
$ docker-compose build
17-
$ docker-compose up -d
18-
$ docker-compose run --rm web ./scripts/populate-instance.sh
19-
$ firefox http://127.0.0.1/records/1
19+
# prerequisites: cookiecutter and pipenv
20+
# scaffold my-site instance
21+
$ cookiecutter gh:inveniosoftware/cookiecutter-invenio-instance \
22+
--checkout v3.2
23+
24+
2. Install
25+
----------
26+
27+
.. code-block:: console
2028
21-
This will start an Invenio demo instance containing several example records and
22-
all the needed services such as PostgreSQL, Elasticsearch, Redis, RabbitMQ.
29+
$ cd my-site/
30+
# start services (db, es, mq, cache)
31+
$ docker-compose up
32+
# build and install my-site instance
33+
$ ./scripts/bootstrap
34+
35+
3. Run
36+
------
37+
38+
.. code-block:: console
2339
24-
For a detailed walk-through on how to set up your Invenio instance, please see
25-
our `installation documentation
26-
<http://invenio.readthedocs.io/en/latest/installation/index.html>`_.
40+
# setup database and indexes
41+
$ ./scripts/setup
42+
# start webserver and task queue
43+
$ ./scripts/server
44+
# your site is running!
45+
$ firefox https://127.0.0.1:5000/

0 commit comments

Comments
 (0)