Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Küng committed Jun 1, 2024
1 parent 7443d67 commit 04a1660
Showing 1 changed file with 1 addition and 35 deletions.
36 changes: 1 addition & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,38 +8,4 @@ This is version 2 of MunkiWebAdmin, a web-based administration tool for Munki.

# Getting started

Check the wiki for getting started

### docker-compose
depending on your needs there is a compose file for a complete setup (munkiwebadmin, DB, munkirepo) or one for just munkiwebadmin with a DB.

#### complete setup
check out the docker-compose.prod.repo.yml and change the URL to something usefull for you.
Run docker compose:
```bash
docker-compose up -f docker-compose.prod.repo.yml
```

#### only munkiwebadmin with DB
check out the docker-compose.prod.yml, change the URL to something usefull for you and also change the munkirepo.
Run docker compose:
```bash
docker-compose up -f docker-compose.prod.yml
```


### Docker variables

| Variable | Usage | Default|
| ------------- |-------------|:------:|
| APPNAME | Django app name | _MunkiWebAdmin_ |
| ALLOWED_HOSTS | django allowed hosts. e.g. _[ munkiwebadmin.example.com ]_ |_[ * ]_|
| DEFAULT_MANIFEST | default manifest to use. _serail_number_ or _hostname_ |_serial_number_ |
| DB | Database type. currently only postgres possible | postgres |
| DB_NAME | Database name | _munkiwebadmin_db_ |
| DB_USER | Database user | _postgres_ |
| DB_PASS | Database password | _postgres_ |
| DB_HOST | Database host | _db_ |
| DB_PORT | Database port | _5432_ |


Check the wiki to get started

0 comments on commit 04a1660

Please sign in to comment.