Skip to content

Commit da738df

Browse files
committed
Update Getting Started guide with new images
1 parent 83f7566 commit da738df

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

_posts/2024-04-02-getting-started.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Getting Started
33
author: tom
4-
date: 2024-04-02 13:37:00 +0800
4+
date: 2025-08-27 13:37:00 +0800
55
categories: [Setup, Tutorial]
66
tags: [installation, getting started]
77
---
@@ -26,12 +26,24 @@ tags: [installation, getting started]
2626
pip3 install jinja2
2727
```
2828

29-
3. Run the setup script:
29+
3. Run the setup script, which will create a `.env` file with default settings. You can edit this file later to change settings like passwords or ports.:
3030

3131
```bash
3232
python3 ./setup.py
3333
```
34+
35+
#### Option 1: Just Run (for users)
36+
4. Start the containers
3437

38+
```bash
39+
chown -R $(id -u):$(id -g) ./blob_storage
40+
docker compose -f docker-compose-release.yml up
41+
```
42+
The first start takes some time because the database will change the mode to a replica-set.
43+
Wait until the logscreen stops moving (takes usually 2 to 5 minutes).
44+
45+
46+
#### Option 2: Build Source (for developers)
3547
4. Build the docker base images (takes some time).
3648

3749
```bash
@@ -43,11 +55,12 @@ tags: [installation, getting started]
4355

4456
```bash
4557
chown -R $(id -u):$(id -g) ./blob_storage
46-
docker-compose up
58+
docker compose up
4759
```
4860
The first start takes some time because the database will change the mode to a replica-set.
4961
Wait until the logscreen stops moving (takes usually 2 to 5 minutes).
5062

63+
### Usage
5164
6. Open the browser under [https://fmd.localhost](https://fmd.localhost). By default, a self-signed certificates is used, and you will encounter a TLS warning.
5265

5366
7. Log-into the application. Password and username can be found in the `.env` file within the root directory of the server.
@@ -60,7 +73,8 @@ tags: [installation, getting started]
6073
...
6174
```
6275

63-
8. After log-in, you can explore the following routes:
64-
- [GraphQL API (/graphql/)](https://fmd.localhost/graphql/)
65-
- [User-Management (/admin/)](https://fmd.localhost/admin/)
66-
- [RQ-Job Management (/django-rq/)](https://fmd.localhost/django-rq/)
76+
8. After log-in (via https://fmd.localhost/admin), you can explore the following routes:
77+
- [Frontend (https://fmd.localhost/)](https://fmd.localhost/)
78+
- [GraphQL API (https://fmd.localhost/graphql/)](https://fmd.localhost/graphql/)
79+
- [User-Management (https://fmd.localhost/admin/)](https://fmd.localhost/admin/)
80+
- [RQ-Job Management (https://fmd.localhost/django-rq/)](https://fmd.localhost/django-rq/)

0 commit comments

Comments
 (0)