Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

  • 7e8dde2
  • /
  • postgresql.rst
Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
content badge
swh:1:cnt:5c91af60a44663839d241fac9576ecd651a58833
directory badge
swh:1:dir:7e8dde2beac97b5343868e407e6b764ed4775caa

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
postgresql.rst
Prepare PostgreSQL
==================

There should already be a system user, likely ``postgres``.

Become root:

.. code-block:: console

    $ su
    <enter root password>

Switch to the ``postgres`` user:

.. code-block:: console

    # su postgres

Create a database user named ``byceps``:

.. code-block:: console

    postgres@host$ createuser --echo --pwprompt byceps

You should be prompted to enter a password. Do that.

In your :doc:`BYCEPS configuration file <byceps-config-file>`, replace
the example password in the value of :confval:`SQLALCHEMY_DATABASE_URI`
with the one you just entered.

Create a schema, also named ``byceps``:

.. code-block:: console

    postgres@host$ createdb --encoding=UTF8 --template=template0 --owner byceps byceps

To run the tests (optional), a dedicated user and database have to be
created:

.. code-block:: console

    postgres@host$ createuser --echo --pwprompt byceps_test
    postgres@host$ createdb --encoding=UTF8 --template=template0 --owner byceps_test byceps_test

Connect to the database:

.. code-block:: console

    $ psql

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API