Merge pull request #1159 from AletheiaFact/stage

Production Release: 1.0.1

.env.example

@@ -35,7 +35,7 @@ SMTP_REFRESH_TOKEN=
 
 # FEATURE FLAG #######
 GITLAB_FEATURE_FLAG_URL=
-ENV=
+ENV=local
 GITLAB_FEATURE_FLAG_INSTANCE_ID=
 # AWS
 AWS_SDK_BUCKET=aletheia

.github/workflows/nodejs.yml

@@ -11,8 +11,8 @@ on:
 
 env:
   UMAMI_SITE_ID: ${{ secrets.DEVELOPMENT_UMAMI_SITE_ID }}
-  ORY_SDK_URL: ${{ secrets.DEVELOPMENT_ORY_SDK_URL }}
-  ORY_ACCESS_TOKEN: ${{ secrets.DEVELOPMENT_ORY_ACCESS_TOKEN }}
+  ORY_SDK_URL: http://127.0.0.1:4433 #${{ secrets.DEVELOPMENT_ORY_SDK_URL }}
+  # ORY_ACCESS_TOKEN: ${{ secrets.DEVELOPMENT_ORY_ACCESS_TOKEN }}
   ALETHEIA_SCHEMA_ID: ${{ secrets.DEVELOPMENT_ALETHEIA_SCHEMA_ID }}
   CI_ORY_USERID: ${{ secrets.CI_ORY_USERID }}
   CI_ORY_USER_PASSWORD: ${{ secrets.CI_ORY_USER_PASSWORD }}
@@ -96,8 +96,6 @@ jobs:
       with:
         name: aletheia-dist
         path: dist
-    - name: List contents of aletheia-dist
-      run: ls -lah /home/runner/work/aletheia/aletheia
     - run: |
         echo '{"CI_ORY_USER_PASSWORD": "${{ env.CI_ORY_USER_PASSWORD }}"}' > ./cypress.env.json
         yarn install

.gitignore

@@ -12,6 +12,7 @@
 
 # misc
 .DS_Store
+/**/*/._.DS_Store
 .env.local
 .env.development.local
 .env.test.local

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npx lint-staged
+yarn lint-staged

README.md

@@ -11,7 +11,7 @@
   git clone https://github.com/<your-username>/aletheia
   cd aletheia
   ```
-- Startup Mongo DB via Docker:
+- Startup Mongo DB via Docker and Ory Kratos:
   ``` sh
   docker-compose up -d
   ```
@@ -38,7 +38,39 @@
 yarn build
 ```
 ## Configuring Ory 
+### Local environment
+Execute the following command to start Ory Kratos using Docker Compose:
+```sh
+docker-compose up kratos kratos-migrate
+```
+
+You can also use the self-service-ui-node and maisluper images to have a better experience debugging Ory.
+
+#### 3. Verify the Ory Kratos Installation
+After starting the service, you can verify that it's running by accessing the admin panel:
+- Open your web browser and go to [http://localhost:4434/admin](http://localhost:4434/admin)
+- You should see a `404 page not found` message, which indicates that the server is running but the requested endpoint does not exist.
+
+#### 4. Configuration Setup
+- Configuring YAML Files
+Copy the Ory configurations from `config.example.yaml` to your `config.yaml` and `config.seed.yaml`:
+- - Replace the values for `url`, `admin_url`, `admin_endpoint`, and `schema_id` with the appropriate values based on your setup in `config.example.yaml`.
+
+- Configuring Environment Variables
+Copy the Ory configurations from `.env.example` to your `.env` file:
+- - Update the `NEXT_PUBLIC_ORY_SDK_URL` and `ORY_SDK_URL` variables as specified in the `.env.example` file.
 
+#### 5. Seed the Database
+Run the following command to seed the database with initial data:
+```sh
+yarn seed
+```
+
+#### 6. Verify User Creation
+Check if users were created successfully by accessing the identities page:
+- Open [http://localhost:4434/admin/identities](http://localhost:4434/admin/identities) in your browser.
+
+### Ory Cloud
 #### Taking What You Need:
 - Create an account and a project on https://console.ory.sh/login.
 - Copy the SDK Configuration url and save it.
@@ -82,7 +114,7 @@ yarn build
           "type": "string"
         },
         "role": {
-          "type": "string"
+          "type": "object"
         }
       },
       "required": [

config.development.yaml

@@ -1,36 +1,5 @@
-# Number of worker processes to spawn.
-# Set to 0 to run everything in a single process without clustering.
-# Use 'ncpu' to run as many workers as there are CPU units
-num_workers: 2
-
-# Number of workers to start in parallel after the first worker.
-# The first worker is always started independently. After it has completed
-# its start-up, this number controls the number of workers to start in
-# parallel until `num_workers` have been started. Note that setting this
-# number to a too high a value might lead to high resource consumption
-# (especially of CPU) during the start-up process.
-startup_concurrency: 1
-
-# Log error messages and gracefully restart a worker if v8 reports that it
-# uses more heap (note: not RSS) than this many mb.
-worker_heap_limit_mb: 750
-
-# The maximum interval in ms that can pass between two beat messages
-# sent by each worker to the master before it is killed
-worker_heartbeat_timeout: 15000
-
-# Logger info
-logging:
-  level: trace
-  streams:
-  - type: stdout # log to stdout
-    named_levels: true # emit log level name instead of index. e.g. INFO vs 30
-
-# Using config.yaml with wikimedia service-runner pattern
 services:
   - name: service-aletheia
-    # path relative to the __dirname variable
-    module: dist/server/main.js
     conf:
       port: 3000
       cors: '*'
@@ -53,6 +22,8 @@ services:
       authentication_type: ory
       ory:
         url: ORY_SDK_URL
+        admin_url: ORY_SDK_URL
+        admin_endpoint: api/kratos/admin 
         access_token: ORY_ACCESS_TOKEN
         schema_id: ALETHEIA_SCHEMA_ID
       feature_flag:

config.example.yaml

@@ -1,27 +1,11 @@
-# Number of worker processes to spawn.
-# Use 'ncpu' to run as many workers as there are CPU units
-num_workers: 1
-
-# Log error messages and gracefully restart a worker if v8 reports that it
-# uses more heap (note: not RSS) than this many mb.
-# worker_heap_limit_mb: 250
-
-# Logger info
-logging:
-  level: trace
-  streams:
-  - type: stdout # log to stdout
-    named_levels: true # emit log level name instead of index. e.g. INFO vs 30
-
-# Using config.yaml with wikimedia service-runner pattern
 services:
   - name: service-aletheia
-    # path relative to the __dirname variable
-    module: dist/server/main.js
     conf:
       port: 3000
       cors: '*'
       debug: true
+      websocketUrl: ws://localhost:5001
+      agentsUrl: http://localhost:8000
       #override_public_routes: true
       recaptcha_secret: RECAPTCHA_SECRET
       recaptcha_sitekey: 6Lc2BtYUAAAAAOUBI-9r1sDJUIfG2nt6C43noOXh
@@ -38,6 +22,9 @@ services:
       authentication_type: ory
       ory:
         url: ORY_SDK_URL
+        # Use "admin" as the endpoint when running locally.
+        # When using the cloud, the endpoint should be "api/kratos/admin".
+        admin_endpoint:
         access_token: ORY_ACCESS_TOKEN
         schema_id: ALETHEIA_SCHEMA_ID
       feature_flag:

config.production.yaml

@@ -1,36 +1,5 @@
-# Number of worker processes to spawn.
-# Set to 0 to run everything in a single process without clustering.
-# Use 'ncpu' to run as many workers as there are CPU units
-num_workers: 2
-
-# Number of workers to start in parallel after the first worker.
-# The first worker is always started independently. After it has completed
-# its start-up, this number controls the number of workers to start in
-# parallel until `num_workers` have been started. Note that setting this
-# number to a too high a value might lead to high resource consumption
-# (especially of CPU) during the start-up process.
-startup_concurrency: 1
-
-# Log error messages and gracefully restart a worker if v8 reports that it
-# uses more heap (note: not RSS) than this many mb.
-worker_heap_limit_mb: 750
-
-# The maximum interval in ms that can pass between two beat messages
-# sent by each worker to the master before it is killed
-worker_heartbeat_timeout: 15000
-
-# Logger info
-logging:
-  level: trace
-  streams:
-  - type: stdout # log to stdout
-    named_levels: true # emit log level name instead of index. e.g. INFO vs 30
-
-# Using config.yaml with wikimedia service-runner pattern
 services:
   - name: service-aletheia
-    # path relative to the __dirname variable
-    module: dist/server/main.js
     conf:
       port: 3000
       cors: '*'
@@ -51,6 +20,8 @@ services:
       authentication_type: ory
       ory:
         url: ORY_SDK_URL
+        admin_url: ORY_SDK_URL
+        admin_endpoint: api/kratos/admin 
         access_token: ORY_ACCESS_TOKEN
         schema_id: ALETHEIA_SCHEMA_ID
       feature_flag:

config.seed.example.yaml

@@ -1,20 +1,5 @@
-# Number of worker processes to spawn.
-# Set to 0 to run everything in a single process without clustering.
-# Use 'ncpu' to run as many workers as there are CPU units
-num_workers: 1
-
-# Logger info
-logging:
-  level: trace
-  streams:
-    - type: stdout # log to stdout
-      named_levels: true # emit log level name instead of index. e.g. INFO vs 30
-
-# Using config.yaml with wikimedia service-runner pattern
 services:
   - name: service-aletheia
-    # path relative to the __dirname variable
-    module: dist/server/seed.js
     conf:
       web_url: https://test.aletheiafact.org
       smtp_host: {env(SMTP_CLIENT_HOST)}
@@ -42,5 +27,9 @@ services:
       authentication_type: ory
       ory:
         url: ORY_SDK_URL
+        admin_url: ORY_SDK_URL
+        # Use "admin" as the endpoint when running locally.
+        # When using the cloud, the endpoint should be "api/kratos/admin".
+        admin_endpoint:
         access_token: ORY_ACCESS_TOKEN
         schema_id: ALETHEIA_SCHEMA_ID

config.seed.test.ci.yaml

@@ -1,20 +1,5 @@
-# Number of worker processes to spawn.
-# Set to 0 to run everything in a single process without clustering.
-# Use 'ncpu' to run as many workers as there are CPU units
-num_workers: 0
-
-# Logger info
-logging:
-  level: trace
-  streams:
-    - type: stdout # log to stdout
-      named_levels: true # emit log level name instead of index. e.g. INFO vs 30
-
-# Using config.yaml with wikimedia service-runner pattern
 services:
   - name: ci-seed-command
-    # path relative to the __dirname variable
-    module: dist/server/seed.js
     conf:
       disable_smtp: true
       db:
@@ -30,7 +15,7 @@ services:
           password: {env(CI_ORY_USER_PASSWORD)}
           sendAuthDetails: false
           isTestUser: true
-          oryId: {env(CI_ORY_USERID)}
+          # oryId: {env(CI_ORY_USERID)}
           role: {
             main: super-admin
           }
@@ -39,9 +24,12 @@ services:
         limit: 1000
       authentication_type: ory
       ory:
-        url: {env(ORY_SDK_URL)}
-        access_token: {env(ORY_ACCESS_TOKEN)}
-        schema_id: {env(ALETHEIA_SCHEMA_ID)}
+        url: http://localhost:4433
+        admin_url: http://localhost:4434
+        admin_endpoint: admin
+        # url: {env(ORY_SDK_URL)}
+        # access_token: {env(ORY_ACCESS_TOKEN)}
+        # schema_id: {env(ALETHEIA_SCHEMA_ID)}
       feature_flag:
         url: {env(GITLAB_FEATURE_FLAG_URL)}
         appName: Staging

config.test.ci.yaml

@@ -1,28 +1,5 @@
-# Number of worker processes to spawn.
-# Use 'ncpu' to run as many workers as there are CPU units
-num_workers: 0
-
-# Log error messages and gracefully restart a worker if v8 reports that it
-# uses more heap (note: not RSS) than this many mb.
-# worker_heap_limit_mb: 250
-
-# Logger info
-logging:
-  level: trace
-  streams:
-  - type: stdout # log to stdout
-    named_levels: true # emit log level name instead of index. e.g. INFO vs 30
-
-# Using config.yaml with wikimedia service-runner pattern
 services:
-  - name: ci-websocket-aletheia
-    module: dist/server/websocket.js
-    conf:
-      port: 5001
-
   - name: ci-aletheia-server
-    # path relative to the __dirname variable
-    module: dist/server/main.js
     conf:
       port: 3000
       cors: '*'
@@ -42,9 +19,12 @@ services:
         limit: 1000
       authentication_type: ory
       ory:
-        url: {env(ORY_SDK_URL)}
-        access_token: {env(ORY_ACCESS_TOKEN)}
-        schema_id: {env(ALETHEIA_SCHEMA_ID)}
+        url: http://localhost:4433
+        admin_url: http://localhost:4434
+        admin_endpoint: admin
+        # url: {env(ORY_SDK_URL)}
+        # access_token: {env(ORY_ACCESS_TOKEN)}
+        # schema_id: {env(ALETHEIA_SCHEMA_ID)}
       feature_flag:
         url: {env(GITLAB_FEATURE_FLAG_URL)}
         appName: Staging

config.websocket.development.yaml

@@ -1,22 +1,4 @@
-# Number of worker processes to spawn.
-# Use 'ncpu' to run as many workers as there are CPU units
-num_workers: 0
-
-# Log error messages and gracefully restart a worker if v8 reports that it
-# uses more heap (note: not RSS) than this many mb.
-# worker_heap_limit_mb: 250
-
-# Logger info
-logging:
-  level: trace
-  streams:
-  - type: stdout # log to stdout
-    named_levels: true # emit log level name instead of index. e.g. INFO vs 30
-
-# Using config.yaml with wikimedia service-runner pattern
 services:
   - name: websocket-aletheia-development
-    # path relative to the __dirname variable
-    module: dist/server/websocket.js
     conf:
       port: 5051