Project

General

Profile

Start » History » Version 60

Simó Albert i Beltran, 03/07/2013 02:43 PM
Change format of outdated notice for anonymous mode.

1 15 Pau Escrich
!http://qmp.cat/images/qmp_small.png!
2 1 Pau Escrich
3 17 Pau Escrich
--------------------------------------------------------------------------------------------------------------------------
4 18 Pau Escrich
5 47 Jorge L. Florit
[[Inici|Catalan Version]] | [[Inicio|Spanish Version]]
6 13 Pau Escrich
7 46 Pau Escrich
{{toc}}
8 45 Pau Escrich
9 1 Pau Escrich
h2. What is qMp?
10
11 38 Pau Escrich
* It is firmware for embedded network devices based on "OpenWRT":http://www.openwrt.org Linux operating system
12 44 Pau Escrich
* It provides an easy way to set up networks using MESH it doesn't matter your they are either wired or WiFi or a mix of both
13
* It is a fast and reliable way to extend an Internet uplink to end-users
14
15 1 Pau Escrich
h2. Why?
16
17
Two main purposes:
18
19 6 Pau Escrich
* *For quick deployments*
20
There's no need to think about network topology, all you need to do is to spread the nodes and connect one to internet.
21
Use it in any kind of environments like concerts, meetings, demonstrations or in case of a natural disaster.
22 1 Pau Escrich
23 6 Pau Escrich
* *For the wireless communities*
24
If you are new into this all you need to become part of the existing community or to start building one is to download and install the firmware. It won't take you more than the time you need to take a coffee to have your node ready to be put in place.
25
But if you are already an old hands at wireless communities here is qMp to let you forget about all those weird network administration tricks that don't last more than a day in your mind and focus on what makes your community grow, that is, the nodes deployment.
26 1 Pau Escrich
27
h2. How?
28
29
* Providing a complete autoconfiguration system from the first boot
30
* Using a set of Layer 3 MESH protocols: BMX6 (main), OLSR6 and Babel as backup
31
* Using IPv6 as the main IP protocol
32
* Using IPv4 only for end-user connection (tunneling)
33
* Providing an easy and intuitive administration web interface (LuCI based)
34
35 56 Pau Escrich
36 1 Pau Escrich
* Two main modes
37 56 Pau Escrich
** See this basic example to understand how qMp works in the [[Starting|community mode]].
38 57 Pau Escrich
** And read this short article to understand the differences between [[Roaming-Collaborative|roaming and community modes]].
39 52 Pau Escrich
40 12 Pau Escrich
h2. Devices
41 1 Pau Escrich
42 41 Pau Escrich
Currently the official supported devices are: Alix, Routerstation, RouterstationPro, Ubiquiti M5 products and several TP-Links.
43 6 Pau Escrich
But qMp is Free software, so if it doesn't perfectly suits for you all you need to do is to modify it and send us your patches to let us apply them.
44 31 Pau Escrich
Read the next article to see how to add a new device [[New_device]]
45 1 Pau Escrich
46
h2. Features
47 6 Pau Escrich
48 23 Pau Escrich
# *mesh:* Using a set of mesh protocols to provide automatic networking participation
49 6 Pau Escrich
# *autoconf:* A system to auto-configure all settings. So the user does not need to configure anything.
50
# *qmpinfo:* It is a tool written in Lua to get some information about the QMP system.
51
# *qmpcontrol:* It is a tool written as a shell script to manage the QMP system.
52
# *qMp webint:* A LUCI (web interface) module to manage and monitor QMP system.
53
# *map:* A map tool (named b6m and written in Shell Scripting using OpenStreetMaps) to see the position of all network nodes and how are they connected.
54
# *internet detect:* A tool (named gwck) written in Shell Script which is monitoring if the node is connected to internet, in this case it modifies all needed things to share it with the whole network.
55 1 Pau Escrich
56 40 Pau Escrich
Take a look to the screenshots section: [[Screenshots|Screenshots]]
57 39 Pau Escrich
58 7 Pau Escrich
h2. Get the firmware
59
60 19 Pau Escrich
h3. Binary files
61 20 Pau Escrich
62 19 Pau Escrich
Just go to http://fw.qmp.cat to find the binary files ready to install in your device.
63 33 Pau Escrich
Please, choose testing if you can and report the bugs if you find any. 
64 20 Pau Escrich
65 19 Pau Escrich
66 30 Simó Albert i Beltran
h3. From Source (recommended)
67 19 Pau Escrich
68 30 Simó Albert i Beltran
* First of all you should take a look on the system requirements: [[Environment]]
69 1 Pau Escrich
70 35 Pau Escrich
* [Recomended] Get the code using git: <pre>git clone git://qmp.cat/qmpfw.git qmpfw</pre>
71 1 Pau Escrich
72 60 Simó Albert i Beltran
* [Outdated] Or get the code using http: <pre>wget -c -q -O - "http://qmp.cat/gitrevision_download?project_id=7&rev=anonymous" | tar zxvf -</pre>
73 1 Pau Escrich
74 34 Pau Escrich
* Then enter to source directory: <pre>cd qmpfw</pre>
75 1 Pau Escrich
76 59 Simó Albert i Beltran
* [Advanced] Do a checkout specifying the branch: <pre>make .checkout_qmp QMP_GIT_BRANCH=branch_name</pre>
77 1 Pau Escrich
78 35 Pau Escrich
* And compile it specifying the target: <pre>make build T=alix</pre>
79 32 Pau Escrich
80 35 Pau Escrich
You can find available targets by executing: <pre>make list_targets</pre>
81 32 Pau Escrich
82 35 Pau Escrich
If you have more than one core in your computer you can use J=N: <pre>make build T=alix J=4</pre>
83 1 Pau Escrich
84 7 Pau Escrich
After that, you will find the images ready to install in your devices inside directory images/
85 33 Pau Escrich
86 43 Pau Escrich
h3. From package repository
87
88
You can install our packages from any OpenWRT system (backfire). 
89
See section [[Packages|Packages]].
90 7 Pau Escrich
91 21 Pau Escrich
h2. Use the firmware
92
93 30 Simó Albert i Beltran
By default the network interfaces from your device are used for the next purposes (if some of them missing, it is just ignored):
94 21 Pau Escrich
95
* eth0 LAN with DHCP server and IP 172.30.22.1
96
* eth1 WAN with DHCP client running (you can connect it to internet)
97
* wlan0 MESH & ADHOC Routing daemons running using IPv6
98
* wlan1 LAN & AP DHCP server and IP 172.30.22.1
99
* wlan2 MESH & ADHOC Routing daemons running using IPv6
100
101 51 Pau Escrich
So you can access it connecting your computer to eth0 or wlan1 and going via web browser to http://172.30.22.1 or http://admin.qmp using default login:
102 21 Pau Escrich
103
* user: root
104
* password: 13f
105
106 49 Pau Escrich
Check the article [[Starting|How to start a community network]], and many others in the [[/|WiKi]]
107 48 Pau Escrich
108 1 Pau Escrich
h2. Contributions
109
110 50 Pau Escrich
The main part of this project has been freely contributed by a bunch of wireless enthusiast, but in the year 2011 it has been partially funded by Funació PuntCat. 
111 10 Pau Escrich
112
h2. Contact
113
114
* e-mail: info_at_qmp.cat
115
* Users mailing list: https://mail.qmp.cat/cgi-bin/mailman/listinfo/qmp-users
116
* Developers mailing list: https://mail.qmp.cat/cgi-bin/mailman/listinfo/qmp-dev
117 42 Agustí Moll Garcia
* Enterprise: http://routek.cat 
118 10 Pau Escrich
119
<pre>             
120
                 __ _  /\/\  _ __  
121
                / _` |/    \| '_ \ 
122
               | (_| / /\/\ \ |_) |
123
                \__, \/    \/ .__/ 
124
                   |_|      |_|    
125
                                   
126
                 quick MESH project
127
</pre>