README.md - warvox - VoIP based wardialing tool, forked from rapid7/warvox.
HTML git clone git://jay.scot/warvox
DIR Log
DIR Files
DIR Refs
DIR README
---
README.md (2796B)
---
1 # WarVOX
2
3 *Notice*: WarVOX is currently unsupported and unmaintained. YMMV.
4
5 WarVOX is released under a BSD-style license. See docs/LICENSE for more details.
6
7 The latest version of this software is available from http://github.com/rapid7/warvox/
8
9 Questions and suggestions can be sent to:
10 research[at]rapid7.com
11
12 - [Installing](#installing)
13
14 ## Installing
15
16 WarVOX requires a Linux operating system, preferably Ubuntu or Debian.
17
18 WarVOX requires PostgreSQL 9.1 or newer with the "contrib" package installed for integer array support.
19
20 To get started, install the OS-level dependencies:
21 ```
22 $ sudo apt-get install gnuplot lame build-essential libssl-dev libcurl4-openssl-dev \
23 postgresql postgresql-contrib postgresql-common git-core curl libpq-dev sox
24 ```
25
26 Install RVM to obtain Ruby 2.2.5 or later
27 ```
28 $ \curl -L https://get.rvm.io | bash -s stable --autolibs=3 --rails
29 ```
30
31 After RVM is installed you need to run the rvm script provided
32 ```
33 $ source /usr/local/rvm/scripts/rvm
34 ```
35
36 In case you have not installed Ruby 2.2.5 or later by now, do so using RVM.
37 ```
38 $ rvm install ruby-2.2.5
39 ```
40
41 Clone this repository to the location you want to install WarVOX:
42 ```
43 $ git clone git://github.com/rapid7/warvox.git /opt/warvox
44 ```
45
46 Configure WarVOX:
47 ```
48 $ cd /opt/warvox
49 $ bundle install
50 $ make
51 ```
52
53 Verify your installation:
54 ```
55 $ bin/verify_install.rb
56 ```
57
58 Configure the PostgreSQL account for WarVOX:
59 ```
60 $ sudo su - postgres
61 $ createuser -s warvox
62 $ createdb warvox -O warvox
63 $ psql
64 psql> alter user warvox with password 'randompass';
65 psql> exit
66 $ exit
67 ```
68
69 Copy the example database configuration to database.yml:
70 ```
71 $ cp config/database.yml.example config/database.yml
72 ```
73
74 Copy the example secrets configuration to secrets.yml:
75 ```
76 $ cp config/secrets.yml.example config/secrets.yml
77 ```
78 Create a new secrect token:
79 ```
80 $ rake secret > config/session.key
81 ```
82 Modify config/database.yml to include the password set previously
83
84 Initialize the WarVOX database:
85 ```
86 $ make database
87 ```
88
89 Add an admin account to WarVOX
90 ```
91 $ bin/adduser admin randompass
92 ```
93
94 Start the WarVOX daemons:
95 ```
96 $ bin/warvox
97 ```
98
99 or to bind WarVox to all interfaces:
100 ```
101 $ bin/warvox --address 0.0.0.0
102 ```
103
104 Access the web interface at http://127.0.0.1:7777/
105
106 At this point you can configure a new IAX2 provider, create a project, and start making calls.
107
108 ## Assets
109
110 To get assets to show up, you need to first compile assets in production environment:
111
112 ```
113 RAILS_ENV=production bundle exec rake assets:precompile
114 ```
115 This will compile all static assets into `public` folder.
116
117 Next, you need to enable the `RAILS_SERVE_STATIC_FILES` environment variable through the terminal:
118
119 ```
120 export RAILS_SERVE_STATIC_FILES=true
121 ```
122 or wrap the above in a `.env` file and run source:
123
124 ```
125 source .env
126 ```