Skip to content

Commit

Permalink
Update README.md (#138)
Browse files Browse the repository at this point in the history
  • Loading branch information
kingster authored Jul 26, 2024
1 parent cce11a9 commit 4744bf2
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Oreka, an opensource VoIP media capture and retrieval platform

Based on [OrecX](http://www.orecx.com/open-source/) [Oreka](https://github.com/OrecX/Oreka), this project tries to provide a complete Call Recording (SIPREC) solution.
Based on [OrecX](https://web.archive.org/web/20230529191953/http://www.orecx.com/open-source/) [Oreka](https://github.com/OrecX/Oreka), this project tries to provide a complete Call Recording (SIPREC) solution.

[![Build Status](https://travis-ci.com/voiceip/oreka.svg?branch=master)](https://travis-ci.com/voiceip/oreka)

Expand Down Expand Up @@ -35,8 +35,22 @@ Based on [OrecX](http://www.orecx.com/open-source/) [Oreka](https://github.com/O
- Switch to Maven
- Call Play / Download on all platform(s)/OS(es)

### Distribution & Installation

#### Docker

Docker images are available via [docker hub](https://hub.docker.com/r/voiceip/orkaudio/tags), so just run the below command to pull images directly from hub.docker.com. Note: `--net=host` on docker works on linux systems and is a [limitation of docker](https://docs.docker.com/network/host/), so please keep that in mind.

```bash
docker run -it --net=host --restart=always --privileged=true -v /var/log/orkaudio:/var/log/orkaudio -v /etc/orkaudio:/etc/orkaudio voiceip/orkaudio:latest
```

#### Debian/Ubuntu

Binary releases are available from the [Releases Section](https://github.com/voiceip/oreka/releases). Download and refer to the [installation instructions](https://github.com/voiceip/oreka/wiki/Installation).


### Building
### Building

#### Docker

Expand All @@ -52,19 +66,6 @@ docker run -it --net=host --restart=always --privileged=true -v /var/log/orkaudi
The build tool is separately available at [github:Oreka-build](https://github.com/voiceip/oreka-build) which builds the project on a Ubuntu14.04 Virtual Box.
You can natively build if you have all dependencies but I develop on a OSx system, so have kept it separate.

### Distribution & Installation

#### Docker

Docker images are available via [docker hub](https://hub.docker.com/r/voiceip/orkaudio/tags), so just run the below command to pull images directly from hub.docker.com. Note: `--net=host` on docker works on linux systems and is a [limitation of docker](https://docs.docker.com/network/host/), so please keep that in mind.

```bash
docker run -it --net=host --restart=always --privileged=true -v /var/log/orkaudio:/var/log/orkaudio -v /etc/orkaudio:/etc/orkaudio voiceip/orkaudio:latest
```

#### Debian/Ubuntu

Binary releases are available from the [Releases Section](https://github.com/voiceip/oreka/releases). Download and refer to the [installation instructions](https://github.com/voiceip/oreka/wiki/Installation).


#### More Information
Expand Down

0 comments on commit 4744bf2

Please sign in to comment.