Changeset View
Changeset View
Standalone View
Standalone View
docs/getting-started.rst
| .. highlight:: bash | .. highlight:: bash | ||||
| .. _getting-started: | .. _getting-started: | ||||
| Run your own Software Heritage | Run your own Software Heritage | ||||
| ============================== | ============================== | ||||
| This tutorial will guide from the basic step of obtaining the source code of | 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 | 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 | archive source code and browse it on the web. To that end, just follow the | ||||
| steps detailed below. | steps detailed below. | ||||
| Using Docker | Using Docker | ||||
| ++++++++++++ | ------------ | ||||
| The easiest way to run a Software Heritage instance is to use Docker and | The easiest way to run a Software Heritage instance is to use Docker and | ||||
| docker-compose. Please refer to the `docker-compose documentation | docker-compose. Please refer to the `docker-compose documentation | ||||
| <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-environment.git | git clone https://forge.softwareheritage.org/source/swh-environment.git | ||||
| Show All 16 Lines | |||||
| - http://localhost:5080/objstorage | - http://localhost:5080/objstorage | ||||
| At this point, the simplest way to start loading 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: | Code Now' feature of the archive web interface: | ||||
| http://localhost:5080/browse/origin/save/ | http://localhost:5080/browse/origin/save/ | ||||
| For details and an overview of what you can do with your Software Heritage, | For details and an overview of what you can do with your Software Heritage, | ||||
| see `docker/README.md`_ | see the full :ref:`docker-environment` documentation. | ||||
| Enjoy filling your hard drives! | Enjoy filling your hard drives! | ||||
| .. _docker/README.md: https://forge.softwareheritage.org/source/swh-environment/browse/master/docker/ | |||||
| Hacking the archive | Hacking the archive | ||||
| +++++++++++++++++++ | ------------------- | ||||
| If you want to hack the code of the Software Heritage Archive, a bit more work | If you want to hack the code of the Software Heritage Archive, a bit more work | ||||
| will be required. | will be required. | ||||
| To be able to write patches, you will need a development setup. | 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 | The best way to have a development-friendly environment is to build a mixed | ||||
| docker/virtualenv setup. | docker/virtualenv setup. | ||||
| Such a setup is described in the | Such a setup is described in the | ||||
| :ref:`Developer Setup Guide <developer-setup>`. | :ref:`Developer Setup Guide <developer-setup>`. | ||||