Skip to content

Commit

Permalink
Merge pull request #1289 from assemblee-virtuelle/deploy-website-with…
Browse files Browse the repository at this point in the history
…-ssh

Fix website and deploy it automatically
  • Loading branch information
srosset81 authored Jul 29, 2024
2 parents 2a8bb8d + 3298ec5 commit 98f09b3
Show file tree
Hide file tree
Showing 10 changed files with 77 additions and 33 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/deploy-dev.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Deploy

on:
push:
branches: ['next']
paths: ['website/**']
# Allows you to run this workflow manually from the Actions tab on GitHub.
workflow_dispatch:

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: build and start docker container
uses: appleboy/ssh-action@v1.0.3
with:
host: semapps.org
username: ${{ secrets.USERNAME }}
key: ${{ secrets.PRIVATE_KEY }}
port: 22
script: |
cd deployment_semapps_av
docker compose build semapps-website-dev
docker compose up -d semapps-website-dev
24 changes: 24 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Deploy

on:
push:
branches: ['master']
paths: ['website/**']
# Allows you to run this workflow manually from the Actions tab on GitHub.
workflow_dispatch:

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: build and start docker container
uses: appleboy/ssh-action@v1.0.3
with:
host: semapps.org
username: ${{ secrets.USERNAME }}
key: ${{ secrets.PRIVATE_KEY }}
port: 22
script: |
cd deployment_semapps_av
docker compose build semapps-website
docker compose up -d semapps-website
2 changes: 1 addition & 1 deletion website/docs/middleware/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This service allows you to easily configure standard SemApps services. It is off
- [JsonLdService](jsonld)
- [LdpService](ldp)
- [SignatureService](crypto/signature)
- [KeysService](crypto/key-service)
- [KeysService](crypto/keys)
- [SparqlEndpointService](sparql-endpoint)
- [TripleStoreService](triplestore)
- [VoidService](void.md)
Expand Down
10 changes: 6 additions & 4 deletions website/docs/middleware/crypto/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Crypto Package
title: Crypto
---

This package contains key management and signature services.
Expand All @@ -15,11 +15,13 @@ This package contains key management and signature services.
- [LdpService](../ldp/)
- [Ontologies](../ontologies)

## Sub-services
## Services

- [KeysService](./keys)
- [SignatureService](./signature)
- [KeysService](./key-service)
- [MigrationService](./migration-service)
- [ProxyService](./proxy)
- [MigrationService](./migration)
- [KeypairService](./keypair) (deprecated)

## Install

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
---
title: [Deprecated] KeypairService
title: KeypairService
---

# Deprecation Notice

:::warning
This Service has been deprecated in favor of the new keys service which stores keys in the pod's `/keys` container instead of the filesystem.
Please consider migrating by calling `keys.migration.migrateKeysToDb`. Before migration, the new service can not operate and ED25519 keys are not supported by this service.
After migration requests will be redirected to the new service.

# Private/public key pairs management
Please consider migrating by calling `keys.migration.migrateKeysToDb`. Before migration, the new service can not operate and ED25519 keys are not supported by this service. After migration requests will be redirected to the new service.
:::

## Features

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Keys Service
title: KeysService
---

Supersedes the signature keypair service.

# Private/public key pairs management
Private/public key pairs management

## Features

Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,17 @@
---
title: Migration Service
title: MigrationService
---

Service to migrate keys from the deprecated `KeypairService` to the new `KeysService`. The old one uses a file system key store, the new one stores keys in the db.
Note, you can only use the new keys service if you have migrated your keys.

# Migration to the new keys service store
Service to migrate keys from the deprecated [`KeypairService`](keypair) to the new [`KeysService`](keys). The old one uses a file system key store, the new one stores keys in the triple store. Note, you can only use the new keys service if you have migrated your keys.

## Features

- Check, if keys have been migrated
- Check if keys have been migrated
- Migrate keys

## Settings

See [KeysService](./key-service) for settings.
See [KeysService](./keys) for settings.

## Actions

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: HTTP Signature
title: SignatureService
---

This service implements [HTTP Signature](https://tools.ietf.org/html/draft-cavage-http-signatures-12) authentication, which allow to send messages in a secure way between servers. It is used in particular with the [ActivityPub](../activitypub) federation mechanism.
Expand All @@ -14,15 +14,11 @@ This service implements [HTTP Signature](https://tools.ietf.org/html/draft-cavag

## Sub-services

- [KeypairService](keypair.md) (deprecated and superseded by [KeysService](../key-service))

## Other services

- [ProxyService](proxy.md)
- [KeypairService](keypair) (deprecated and superseded by [KeysService](keys))

## Dependencies

- [KeysService](../key-service)
- [KeysService](keys)

## Usage

Expand Down
12 changes: 9 additions & 3 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,18 @@ module.exports = {

{
type: 'category',
label: 'HTTP Signature',
label: 'Crypto',
link: {
type: 'doc',
id: 'middleware/signature/index'
id: 'middleware/crypto/index'
},
items: ['middleware/signature/keypair', 'middleware/signature/proxy']
items: [
'middleware/crypto/keys',
'middleware/crypto/signature',
'middleware/crypto/proxy',
'middleware/crypto/migration',
'middleware/crypto/keypair'
]
},
{
type: 'category',
Expand Down

0 comments on commit 98f09b3

Please sign in to comment.