Skip to content

Commit 93b9725

Browse files
committed
Update Sidebar and add Code Group
1 parent e05c2ee commit 93b9725

File tree

2 files changed

+22
-28
lines changed

2 files changed

+22
-28
lines changed

.vitepress/config.mts

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -70,20 +70,12 @@ export default defineConfig({
7070
sidebar: [
7171
{
7272
text: 'Guides',
73+
collapsed: false,
7374
items: [
74-
{
75-
text: 'Get Started',
76-
collapsed: false,
77-
link: '/guides/get-started',
78-
items: [
79-
{ text: 'Server Setup', link: '/guides/setup' },
80-
{ text: 'Uploading', link: '/guides/upload' },
81-
],
82-
},
83-
{
84-
text: 'Features',
85-
link: '/guides/features',
86-
},
75+
{ text: 'Get Started', link: '/guides/get-started' },
76+
{ text: 'Server Setup', link: '/guides/setup' },
77+
{ text: 'Uploading', link: '/guides/upload' },
78+
{ text: 'Features', link: '/guides/features' },
8779
],
8880
},
8981
{

docs/guides/get-started.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,11 @@ You can also view the 🛠️ [Features](features.md) and 📸 [Screenshots](fea
1212

1313
## Running
1414

15-
You can use either [Docker Run](#docker-run) or [Docker Compose](#docker-compose).
15+
The fastest way to get up and running is with [Docker](https://www.docker.com/).
1616

17-
### Docker Run
17+
::: code-group
1818

19-
```shell
20-
docker run --name "django-files" -d --restart unless-stopped \
21-
-p 80:80 -v /data/django-files:/data/media \
22-
-e USERNAME=myadminuser \
23-
-e PASSWORD=pleasechangeme \
24-
ghcr.io/django-files/django-files:latest
25-
```
26-
27-
### Docker Compose
28-
29-
```shell
19+
```shell [Docker Compose]
3020
version: '3'
3121

3222
services:
@@ -44,6 +34,18 @@ volumes:
4434
media_dir:
4535
```
4636

37+
```shell [Docker CLI]
38+
docker run --name "django-files" -d --restart unless-stopped \
39+
-p 80:80 -v /data/django-files:/data/media \
40+
-e USERNAME=myadminuser \
41+
-e PASSWORD=pleasechangeme \
42+
ghcr.io/django-files/django-files:latest
43+
```
44+
45+
:::
46+
47+
_Note: you can run from source; however, this is currently not documented or supported._
48+
4749
## Accessing
4850

4951
Once the server is up and running you can access the site from a web browser.
@@ -52,8 +54,6 @@ If running on your localhost with default port mapping, you can access it here:
5254

5355
- http://localhost/
5456

55-
### Credentials
56-
5757
If you set a `USERNAME` or `PASSWORD` environment variable, use those values.
5858

5959
Otherwise, the default credentials are.
@@ -62,3 +62,5 @@ Otherwise, the default credentials are.
6262
| ------------ | ------- |
6363
| **username** | `admin` |
6464
| **password** | `12345` |
65+
66+
Next you can review the [server setup](setup.md) and start [uploading](upload.md) or check out the [features](features.md).

0 commit comments

Comments
 (0)