diff --git a/docs/getting-started.rst b/docs/getting-started.rst index 1527f85..c009eb1 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -1,62 +1,67 @@ .. highlight:: bash .. _getting-started: Run your own Software Heritage ============================== This tutorial will guide from the basic step of obtaining the source code of the Software Heritage stack to running a local copy of it with which you can archive source code and browse it on the web. To that end, just follow the steps detailed below. Using Docker ++++++++++++ The easiest way to run a Software Heritage instance is to use Docker and docker-compose. Please refer to the `docker-compose documentation `_ if you do not have a working docker setup. Then:: git clone https://forge.softwareheritage.org/source/swh-environment.git cd swh-environment/docker docker-compose up -d When all the containers are up and running, you have a running Software Heritage platform. You should open: - http://localhost:5080/ to navigate your (empty for now) SWH archive, - http://localhost:5080/rabbitmq to access the rabbitmq dashboard (guest/guest), - http://localhost:5080/grafana to explore the platform's metrics (admin/admin), All the internal APIs are also exposed: - http://localhost:5080/scheduler - http://localhost:5080/storage - http://localhost:5080/indexer-storage - http://localhost:5080/deposit - http://localhost:5080/objstorage -At this point, the simplest way to start indexing software is to use the 'Save +At this point, the simplest way to start loading software is to use the 'Save Code Now' feature of the archive web interface: http://localhost:5080/browse/origin/save/ +For details and an overview of what you can do with your Software Heritage, +see `docker/README.md`_ + Enjoy filling your hard drives! +.. _docker/README.md: https://forge.softwareheritage.org/source/swh-environment/browse/master/docker/ + Hacking the archive +++++++++++++++++++ If you want to hack the code of the Software Heritage Archive, a bit more work will be required. To be able to write patches, you will need a development setup. The best way to have a development-friendly environment is to build a mixed docker/virtualenv setup. Such a setup is described in the :ref:`Developer Setup Guide `.