aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 2dbba31a649d35728b6f226f9d4d4441eb0dbaed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# MediaGoblin

A basic container for a [MediaGoblin media server](https://git.sr.ht/~heckyel/mediagoblin).

## Environment variables

 * `DATABASE_URL`: Connection string for database to use for persistence, including credentials. See example below.
 * `NOTIFICATION_EMAIL`: From address for MediaGoblin notification emails.
 * `EMAIL_HOSTNAME`: Hostname used to send outgoing notification emails.
 * `EMAIL_PORT`: Port number used to send outgoing notification emails.
 * `EMAIL_USERNAME`: Username used to connect to outgoing email host.
 * `EMAIL_PASSWORD`: Password used to connect to outgoing email host.
 * `EMAIL_TLS_SSL`: "true" or "false" for using TLS/SSL encryption for sending emails.
 * `EMAIL_STARTTLS`: "true" or "false" for using STARTTLS encryption for sending emails.

## Basic management

Set enviroment file

```console
$ cp -v .env.example .env
```

Run with `docker-compose`

```console
$ docker-compose up -d
```

## User management

Since this image is for running a private MediaGoblin server, user
self-registration is disabled. So, to add a user, first exec into the running
Docker image:

```console
$ docker exec -it mediagoblin bash
```

Where `mediagoblin` is the name of your running Docker container. If you don’t
know the name to use, try looking in `docker ps` output.

Then, add a user (follow the prompts):

```console
# su - mediagoblin
$ ./bin/gmg --conf_file /srv/app/mediagoblin_local.ini adduser
```

Finally, if you want to make the new user into an admin user:

```console
$ ./bin/gmg --conf_file /srv/app/mediagoblin_local.ini makeadmin username
```

Where `username` corresponds to the user you added above.