You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-9Lines changed: 20 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,21 +49,26 @@ We recommend to set up the development environment using Docker, as it allows to
49
49
50
50
First open the folder in the dev-container by using the command palette <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>P</kbd> (or <kbd>ctrl</kbd> instead of <kbd>cmd</kbd>), and typing `Open Folder in Container`.
51
51
52
-
This will create 10 containers :
52
+
This will create 11 containers :
53
53
54
-
-`graasp-core` : Node.js backend of Graasp
54
+
-`core` : Node.js backend of Graasp
55
55
-`db` : PostgreSQL cluster used by multiple services
56
-
-`graasp-etherpad` : Container for the etherpad service
57
-
-`graasp-meilisearch` : Container for the meilisearch service
58
-
-`graasp-redis` : Redis instance to enable websockets
59
-
-`graasp-localstack` : Localstack instance use to fake S3 storage locally
56
+
-`etherpad` : Container for the etherpad service
57
+
-`meilisearch` : Container for the meilisearch service
58
+
-`redis` : Redis instance to enable websockets
59
+
-`localstack` : Localstack instance use to fake S3 storage locally
60
60
-`localfile` : Simple static file server to get files stored in graasp when using the `local` storage option (see the [Utilities section](#utilities))
61
-
-`graasp-iframely` : Iframely instance used to get embeds for links
61
+
-`iframely` : Iframely instance used to get embeds for links
62
62
-`mailer` : Simple mailer instance used to receive emails locally (see the [Utilities section](#utilities))
63
+
-`umami`: An analytics service used instead of Google Analytics
63
64
64
65
> **Important**
65
66
> To use localstack with the Docker installation, it is necessary to edit your `/etc/hosts` with the following line `127.0.0.1 localstack`. This is necessary because the backend creates signed urls with the localstack container hostname. Without changing the hosts, the development machine cannot resolve the `http://localstack` hostname.
66
67
68
+
> **Troubleshoot**
69
+
> If during setup of the devcontainer you get an error like `nudenet Error pull access denied for public.ecr.aws/g...`
70
+
> This can occure if you previously logged in to the public ECR. When you want to pull from the public ECR, you should be unauthenticated. Simply run the following on you host: `docker logout public.ecr.aws`. It will log you out of the public ECR and you should be able to rebuild the containers without issue. If it persissts please [open an issue](https://github.com/graasp/graasp/issues/new?title=NudeNet%20DevContainer%20Docker%20Install%20Issue)
71
+
67
72
Then install the required npm packages with `yarn install`. You should run this command in the docker's terminal, because some packages are built depending on the operating system (eg. `bcrypt`).
68
73
69
74
> **Info**
@@ -222,8 +227,7 @@ GEOLOCATION_API_KEY=
222
227
223
228
### Umami
224
229
225
-
To log into umami in your local instance:
226
-
<https://umami.is/docs/login>
230
+
To log into umami in your local instance: [Umami login documentation](https://umami.is/docs/login)
227
231
228
232
The first time you log in use username: `admin` and password: `umami`. It is recommended to change these.
229
233
@@ -283,6 +287,8 @@ Up tests start from the previous migration state, insert mock data and apply the
283
287
284
288
## Known issues
285
289
290
+
### Data persistence
291
+
286
292
The development environnement uses `localstack` as a local alternative to AWS s3 storage. But persistence accross restarts is not supported without the premium license.
287
293
This means that it is expected that you see 404 on uploaded files after a restart of your computer.
288
294
In details:
@@ -292,6 +298,11 @@ In details:
292
298
293
299
In the future we might investigate different solutions to mocking s3 storage, or improve the local storage to provide a durable local storage option.
294
300
301
+
### Container installation
302
+
303
+
It is possible that the nudenet container pull fails with a 403 status code. This is likely because you are authenticated to the public AWS ECR and trying to pull a public image. Log out of the public ECR with `docker logout public.ecr.aws` and try building the devContainer again.
304
+
305
+
295
306
## Openapi
296
307
297
308
Generate an `openapi.json` specification file by running the following query. You should have built the backend at least once beforehand.
0 commit comments