First of all, define the scope and metadata of the collection:
Largest global social media
, Most used social media in France
, Dating apps
, Platforms providing services to businesses
…)Platform Governance Archive
, France Élections
, Dating
, P2B Compliance Assessment
…)pga
, France-elections
, dating
, p2b-compliance
…)English
, French
, All EU languages
…)EU
, France
, EEA
, USA
, global
…)Create the collection declarations repository by using the demo-declarations
repository as template:
demo-declarations
repository<collection_id>-declarations
. For example: pga-declarations
.first-time-setup
GitHub action to make sure that everything ran fine.<collection_name>
. Maintained by <maintainer>
.”terms-of-service
, terms-of-service-agreements
, terms-and-conditions
, open-terms-archive
.These settings ease the whole contribution process.
main
, check “Require status checks to pass before merging” and add validate_modified_declarations
and validate_schema
as required status checks.Issues labels will be added by the engine as problems are encountered when tracking. The default labels offered by GitHub, such as question
or wontfix
, are relevant for software development but less so for the process prescribed by Open Terms Archive.
deployment/inventory.yml
and set the server information: server IP, username, server fingerprint…Create the snapshots repository by using the demo-snapshots
repository as template:
demo-snapshots
repository<collection_id>-snapshots
.first-time-setup
GitHub action to make sure that everything ran fine.<collection_name>
. Maintained by <maintainer>
.”terms-of-service
, terms-of-service-agreements
, terms-and-conditions
, open-terms-archive
.These settings aim at minimising the otherwise overwhelming amount of information and click targets.
Create the versions repository by using the demo-versions
repository as template:
demo-versions
repository<collection_id>-versions
.first-time-setup
GitHub action to make sure that everything ran fine.<collection_name>
. Maintained by <maintainer>
.”terms-of-service
, terms-of-service-agreements
, terms-and-conditions
, open-terms-archive
.These settings aim at minimising the otherwise overwhelming amount of information and click targets.
For collections to be included in the Open Terms Archive organisation only. For third parties, handle rights however you see fit.
ssh <username>@<host>
(example usernames: debian
, ubuntu
…)ssh-keygen -q -N "" -f ~/.ssh/ota-deploy
authorized_keys
: cat ~/.ssh/ota-deploy.pub >> ~/.ssh/authorized_keys
cat ~/.ssh/ota-deploy.pub
and keep it temporarily for the next stepsssh-add ~/.ssh/ota-deploy
(start the SSH agent before if necessary with eval \
ssh-agent -s``)cat ~/.ssh/ota-deploy
and keep it temporarily for the next stepsNote: user must have the right to sudo
.
Create the following secrets:
SERVER_FINGERPRINT
: obtained with ssh-keyscan -t ed25519 <host>
SERVER_SSH_KEY
: use the previously generated server private keyFill deployment/inventory.yml
:
<host>
(example: 162.19.74.224
)ansible_user: <username>
(example: debian
)ed25519_fingerprint: <server_ssh_fingerprint>
(example: AAAAC3NzaC1lZDI1NTE5AAAAIJkjE1KIbUcoClK+iKLR5ZvmdXMD/eXWghHdenFeJz4c
obtained with ssh-keyscan -t ed25519 <host>
)deploy
action ran properly on the declarations repository.To test deployment from your local machine, your SSH keys must be authorized to connect to the server.
cd <path/to/><collection_id>-declarations/deployment
ansible-playbook opentermsarchive.deployment.deploy