Skip to content

Commit

Permalink
more documentation around profiles
Browse files Browse the repository at this point in the history
  • Loading branch information
jandre committed Sep 20, 2015
1 parent 1cc2478 commit dc0961e
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,22 @@ the div, or supply `codetainer` in the constructor options).
});
```

### API Documentation

*TODO*

### Profiles

*TODO* more documentation.

You can use profiles to apply Docker configs to limit CPU, memory, network access,
and more.

See [example profiles]('./example-profiles') for some examples of this.

Register a profile to use with codetainer using `codetainer profile register <path-to-json> <name of profile>`
and then supply `container-config-id` when POST'ing to `/api/v1/codetainer` to create.

# Status

Codetainer is unstable and in active development.

0 comments on commit dc0961e

Please sign in to comment.