Changeset View
Changeset View
Standalone View
Standalone View
docs/getting-started.rst
| Show All 18 Lines | |||||
| <https://docs.docker.com/compose/>`_ if you do not have a working docker setup. | <https://docs.docker.com/compose/>`_ if you do not have a working docker setup. | ||||
| Then:: | Then:: | ||||
| git clone https://forge.softwareheritage.org/source/swh-docker-dev.git | git clone https://forge.softwareheritage.org/source/swh-docker-dev.git | ||||
| cd swh-docker-dev | cd swh-docker-dev | ||||
| docker-compose up -d | docker-compose up -d | ||||
| When all the containers are up and runnig, you have a running Software | When all the containers are up and running, you have a running Software | ||||
| Heritage platform. You should open: | Heritage platform. You should open: | ||||
| - http://localhost:5080/ to navigate your (empty for now) SWH archive, | - http://localhost:5080/ to navigate your (empty for now) SWH archive, | ||||
| - http://localhost:5080/rabbitmq to access the rabbitmq dashoard (guest/guest), | - http://localhost:5080/rabbitmq to access the rabbitmq dashboard (guest/guest), | ||||
| - http://localhost:5080/prometheus to explore the platform's metrics, | - http://localhost:5080/prometheus to explore the platform's metrics, | ||||
| All the internal APIs are also exposed: | All the internal APIs are also exposed: | ||||
| - http://localhost:5080/scheduler | - http://localhost:5080/scheduler | ||||
| - http://localhost:5080/storage | - http://localhost:5080/storage | ||||
| - http://localhost:5080/indexer-storage | - http://localhost:5080/indexer-storage | ||||
| - http://localhost:5080/deposit | - http://localhost:5080/deposit | ||||
| Show All 15 Lines | |||||
| The best way to have a development-friendly environment is to build a mixed | The best way to have a development-friendly environment is to build a mixed | ||||
| docker/virtual env setup. | docker/virtual env setup. | ||||
| Such a setup is described in the :ref:`Perfect Developer Setup guide | Such a setup is described in the :ref:`Perfect Developer Setup guide | ||||
| <developer-setup>`. | <developer-setup>`. | ||||
| Installing from sources (without a virtualenv) | Installing from sources (without Docker) | ||||
| ++++++++++++++++++++++++++++++++++++++++++++++ | ++++++++++++++++++++++++++++++++++++++++ | ||||
| If you prefer to run everything straight, you should refer to the :ref:`Manual | If you prefer to run everything straight, you should refer to the :ref:`Manual | ||||
| Setup Guide <manual-setup>` | Setup Guide <manual-setup>` | ||||