diff --git a/docs/sys-info.rst b/docs/sys-info.rst index 7a2200bc..70baaf63 100644 --- a/docs/sys-info.rst +++ b/docs/sys-info.rst @@ -1,62 +1,62 @@ Deployment of the swh-deposit ============================= As usual, the debian packaged is created and uploaded to the swh debian repository. Once the package is installed, we need to do a few things in regards to the database. Prepare the database setup (existence, connection, etc...). ----------------------------------------------------------- This is defined through the packaged ``swh.deposit.settings.production`` module and the expected **/etc/softwareheritage/deposit/server.yml**. As usual, the expected configuration files are deployed through our puppet manifest (cf. puppet-environment/swh-site, puppet-environment/swh-role, puppet-environment/swh-profile) Migrate/bootstrap the db schema ------------------------------- .. code:: shell sudo django-admin migrate --settings=swh.deposit.settings.production Load minimum defaults data -------------------------- .. code:: shell sudo django-admin loaddata \ --settings=swh.deposit.settings.production deposit_data This adds the minimal: - deposit request type 'archive' and 'metadata' - 'hal' collection Note: swh.deposit.fixtures.deposit\_data is packaged Add client and collection ------------------------- .. code:: shell - swh-deposit \ + swh deposit admin \ --config-file /etc/softwareheritage/deposit/server.yml \ --platform production \ user create \ --collection \ --username \ --password This adds a user ```` which can access the collection ````. The password will be used for the authentication access to the deposit api. Note: - If the collection does not exist, it is created alongside - The password is plain text but stored encrypted (so yes, for now we know the user's password) - For production platform, you must either set an SWH_CONFIG_FILENAME environment variable or pass alongside the `--config-file` parameter