Skip to content

Commit 8b9a837

Browse files
committed
Use CLI long options
1 parent de25c64 commit 8b9a837

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

content/deployment/how-to/deploy.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,37 @@ weight: 1
55

66
# How to deploy a collection
77

8-
This guide will help you deploy a new Open Terms Archive collection to a server. Follow these steps in order.
8+
This guide will help you deploy an Open Terms Archive collection to a server.
99

1010
## 1. Configure the server
1111

12-
First, ensure your server meets all requirements:
12+
First, ensure your server provides unsupervised access:
1313

1414
1. Check the SSH host key:
1515
```shell
16-
ssh-keyscan -t ed25519 <server_address>
16+
ssh-keyscan --type=ed25519 <server_address>
1717
```
1818
If no Ed25519 key appears, generate one on the server:
1919
```shell
20-
sudo ssh-keygen -t ed25519 -f /etc/ssh/ssh_host_ed25519_key
20+
sudo ssh-keygen --type=ed25519 --file=/etc/ssh/ssh_host_ed25519_key
2121
sudo systemctl restart ssh
2222
```
2323

2424
2. Create a non-root user if needed:
2525
```shell
2626
adduser <user>
27-
usermod -aG sudo <user>
27+
usermod --append --groups=sudo <user>
2828
```
2929

3030
3. Grant passwordless sudo access:
3131
```shell
3232
# Add to /etc/sudoers:
33-
<user> ALL=(ALL) NOPASSWD:ALL
33+
<user> ALL=(ALL) NOPASSWD:ALL
3434
```
3535

3636
## 2. Set up the deployment configuration
3737

38-
1. Clone the collection repository:
38+
1. Clone the collection declarations repository:
3939
```shell
4040
git clone https://github.com/OpenTermsArchive/<collection_id>-declarations.git
4141
```
@@ -55,7 +55,7 @@ First, ensure your server meets all requirements:
5555

5656
1. On the server, generate a deployment key:
5757
```shell
58-
ssh-keygen -t ed25519 -q -N "" -f ~/.ssh/ota-deploy
58+
ssh-keygen --type=ed25519 --quiet --passphrase="" --file=~/.ssh/ota-deploy
5959
cat ~/.ssh/ota-deploy.pub >> ~/.ssh/authorized_keys
6060
```
6161

@@ -104,7 +104,7 @@ First, ensure your server meets all requirements:
104104

105105
1. Generate a new key:
106106
```shell
107-
ssh-keygen -t ed25519 -C [email protected] -P "" -f ./<collection_name>-key
107+
ssh-keygen --type=ed25519 --comment=[email protected] --passphrase="" --file=./<collection_name>-key
108108
```
109109

110110
2. Encrypt and store the private key:
@@ -142,7 +142,7 @@ First, ensure your server meets all requirements:
142142
2. Via local deployment:
143143
```shell
144144
cd <collection_id>-declarations/deployment
145-
ansible-galaxy collection install -r requirements.yml
145+
ansible-galaxy collection install --requirements-file requirements.yml
146146
ansible-playbook opentermsarchive.deployment.deploy
147147
```
148148

0 commit comments

Comments
 (0)