├── .github ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── ALL_README.md ├── LICENSE ├── README.md ├── README_es.md ├── README_eu.md ├── README_fr.md ├── README_gl.md ├── README_it.md ├── README_zh_Hans.md ├── conf ├── dnsmasq_dhcpdv4.conf ├── dnsmasq_dhcpdv6.conf ├── hostapd.conf ├── openvpn_90-hotspot ├── systemd.service ├── systemd_hostapd.service └── ynh-hotspot ├── config_panel.toml ├── doc ├── DESCRIPTION.md ├── DESCRIPTION_fr.md ├── PRE_INSTALL.md ├── PRE_INSTALL_fr.md └── screenshots │ └── hotspot.png ├── manifest.toml ├── scripts ├── _common.sh ├── backup ├── config ├── install ├── remove ├── restore └── upgrade └── tests.toml /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently. 4 | 5 | --- 6 | 7 | **How to post a meaningful bug report** 8 | 1. *Read this whole template first.* 9 | 2. *Determine if you are on the right place:* 10 | - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* 11 | - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* 12 | - *When in doubt, post here and we will figure it out together.* 13 | 3. *Delete the italic comments as you write over them below, and remove this guide.* 14 | --- 15 | 16 | ### Describe the bug 17 | 18 | *A clear and concise description of what the bug is.* 19 | 20 | ### Context 21 | 22 | - Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* 23 | - YunoHost version: x.x.x 24 | - I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* 25 | - Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* 26 | - If yes, please explain: 27 | - Using, or trying to install package version/branch: 28 | - If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* 29 | 30 | ### Steps to reproduce 31 | 32 | - *If you performed a command from the CLI, the command itself is enough. For example:* 33 | ```sh 34 | sudo yunohost app install the_app 35 | ``` 36 | - *If you used the webadmin, please perform the equivalent command from the CLI first.* 37 | - *If the error occurs in your browser, explain what you did:* 38 | 1. *Go to '...'* 39 | 2. *Click on '...'* 40 | 3. *Scroll down to '...'* 41 | 4. *See error* 42 | 43 | ### Expected behavior 44 | 45 | *A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* 46 | 47 | ### Logs 48 | 49 | *When an operation fails, YunoHost provides a simple way to share the logs.* 50 | - *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* 51 | - *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* 52 | 53 | *After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* 54 | 55 | *If applicable and useful, add screenshots to help explain your problem.* 56 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Problem 2 | 3 | - *Description of why you made this PR* 4 | 5 | ## Solution 6 | 7 | - *And how do you fix that problem* 8 | 9 | ## PR Status 10 | 11 | - [ ] Code finished and ready to be reviewed/tested 12 | - [ ] The fix/enhancement were manually tested (if applicable) 13 | 14 | ## Automatic tests 15 | 16 | Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) 17 | -------------------------------------------------------------------------------- /ALL_README.md: -------------------------------------------------------------------------------- 1 | # All available README files by language 2 | 3 | - [Read the README in English](README.md) 4 | - [Lea el README en español](README_es.md) 5 | - [Irakurri README euskaraz](README_eu.md) 6 | - [Lire le README en français](README_fr.md) 7 | - [Le o README en galego](README_gl.md) 8 | - [阅读中文（简体）的 README](README_zh_Hans.md) 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Wifi Hotspot for YunoHost 7 | 8 | [![Integration level](https://dash.yunohost.org/integration/hotspot.svg)](https://dash.yunohost.org/appci/app/hotspot) ![Working status](https://ci-apps.yunohost.org/ci/badges/hotspot.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/hotspot.maintain.svg) 9 | 10 | [![Install Wifi Hotspot with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hotspot) 11 | 12 | *[Read this README in other languages.](./ALL_README.md)* 13 | 14 | > *This package allows you to install Wifi Hotspot quickly and simply on a YunoHost server.* 15 | > *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.* 16 | 17 | ## Overview 18 | 19 | * Broadcast a Wi-Fi access point from your self-hosted server 20 | * Combine with the [VPN Client app](https://github.com/labriqueinternet/vpnclient_ynh) to obtain a VPN-protected WiFi 21 | 22 | 23 | **Shipped version:** 2.3.1~ynh1 24 | 25 | ## Screenshots 26 | 27 | ![Screenshot of Wifi Hotspot](./doc/screenshots/hotspot.png) 28 | 29 | ## Documentation and resources 30 | 31 | - Official app website: 32 | - YunoHost Store: 33 | - Report a bug: 34 | 35 | ## Developer info 36 | 37 | Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing). 38 | 39 | To try the `testing` branch, please proceed like that: 40 | 41 | ```bash 42 | sudo yunohost app install https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 43 | or 44 | sudo yunohost app upgrade hotspot -u https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 45 | ``` 46 | 47 | **More info regarding app packaging:** 48 | -------------------------------------------------------------------------------- /README_es.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Wifi Hotspot para Yunohost 7 | 8 | [![Nivel de integración](https://dash.yunohost.org/integration/hotspot.svg)](https://dash.yunohost.org/appci/app/hotspot) ![Estado funcional](https://ci-apps.yunohost.org/ci/badges/hotspot.status.svg) ![Estado En Mantención](https://ci-apps.yunohost.org/ci/badges/hotspot.maintain.svg) 9 | 10 | [![Instalar Wifi Hotspot con Yunhost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hotspot) 11 | 12 | *[Leer este README en otros idiomas.](./ALL_README.md)* 13 | 14 | > *Este paquete le permite instalarWifi Hotspot rapidamente y simplement en un servidor YunoHost.* 15 | > *Si no tiene YunoHost, visita [the guide](https://yunohost.org/install) para aprender como instalarla.* 16 | 17 | ## Descripción general 18 | 19 | * Broadcast a Wi-Fi access point from your self-hosted server 20 | * Combine with the [VPN Client app](https://github.com/labriqueinternet/vpnclient_ynh) to obtain a VPN-protected WiFi 21 | 22 | 23 | **Versión actual:** 2.3.1~ynh1 24 | 25 | ## Capturas 26 | 27 | ![Captura de Wifi Hotspot](./doc/screenshots/hotspot.png) 28 | 29 | ## Documentaciones y recursos 30 | 31 | - Sitio web oficial: 32 | - Catálogo YunoHost: 33 | - Reportar un error: 34 | 35 | ## Información para desarrolladores 36 | 37 | Por favor enviar sus correcciones a la [`branch testing`](https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing 38 | 39 | Para probar la rama `testing`, sigue asÍ: 40 | 41 | ```bash 42 | sudo yunohost app install https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 43 | o 44 | sudo yunohost app upgrade hotspot -u https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 45 | ``` 46 | 47 | **Mas informaciones sobre el empaquetado de aplicaciones:** 48 | -------------------------------------------------------------------------------- /README_eu.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Wifi Hotspot YunoHost-erako 7 | 8 | [![Integrazio maila](https://dash.yunohost.org/integration/hotspot.svg)](https://dash.yunohost.org/appci/app/hotspot) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/hotspot.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/hotspot.maintain.svg) 9 | 10 | [![Instalatu Wifi Hotspot YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hotspot) 11 | 12 | *[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* 13 | 14 | > *Pakete honek Wifi Hotspot YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* 15 | > *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* 16 | 17 | ## Aurreikuspena 18 | 19 | * Broadcast a Wi-Fi access point from your self-hosted server 20 | * Combine with the [VPN Client app](https://github.com/labriqueinternet/vpnclient_ynh) to obtain a VPN-protected WiFi 21 | 22 | 23 | **Paketatutako bertsioa:** 2.3.1~ynh1 24 | 25 | ## Pantaila-argazkiak 26 | 27 | ![Wifi Hotspot(r)en pantaila-argazkia](./doc/screenshots/hotspot.png) 28 | 29 | ## Dokumentazioa eta baliabideak 30 | 31 | - Aplikazioaren webgune ofiziala: 32 | - YunoHost Denda: 33 | - Eman errore baten berri: 34 | 35 | ## Garatzaileentzako informazioa 36 | 37 | Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing). 38 | 39 | `testing` abarra probatzeko, ondorengoa egin: 40 | 41 | ```bash 42 | sudo yunohost app install https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 43 | edo 44 | sudo yunohost app upgrade hotspot -u https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 45 | ``` 46 | 47 | **Informazio gehiago aplikazioaren paketatzeari buruz:** 48 | -------------------------------------------------------------------------------- /README_fr.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Wifi Hotspot pour YunoHost 7 | 8 | [![Niveau d’intégration](https://dash.yunohost.org/integration/hotspot.svg)](https://dash.yunohost.org/appci/app/hotspot) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/hotspot.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/hotspot.maintain.svg) 9 | 10 | [![Installer Wifi Hotspot avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hotspot) 11 | 12 | *[Lire le README dans d'autres langues.](./ALL_README.md)* 13 | 14 | > *Ce package vous permet d’installer Wifi Hotspot rapidement et simplement sur un serveur YunoHost.* 15 | > *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* 16 | 17 | ## Vue d’ensemble 18 | 19 | * Diffusez un point d'accès Wi-Fi depuis votre serveur auto-hébergé 20 | * À combiner avec l'[app VPN Client](https://github.com/labriqueinternet/vpnclient_ynh) pour obtenir un accès internet aumatiquement protégé par votre VPN 21 | 22 | 23 | **Version incluse :** 2.3.1~ynh1 24 | 25 | ## Captures d’écran 26 | 27 | ![Capture d’écran de Wifi Hotspot](./doc/screenshots/hotspot.png) 28 | 29 | ## Documentations et ressources 30 | 31 | - Site officiel de l’app : 32 | - YunoHost Store : 33 | - Signaler un bug : 34 | 35 | ## Informations pour les développeurs 36 | 37 | Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing). 38 | 39 | Pour essayer la branche `testing`, procédez comme suit : 40 | 41 | ```bash 42 | sudo yunohost app install https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 43 | ou 44 | sudo yunohost app upgrade hotspot -u https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 45 | ``` 46 | 47 | **Plus d’infos sur le packaging d’applications :** 48 | -------------------------------------------------------------------------------- /README_gl.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Wifi Hotspot para YunoHost 7 | 8 | [![Nivel de integración](https://dash.yunohost.org/integration/hotspot.svg)](https://dash.yunohost.org/appci/app/hotspot) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/hotspot.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/hotspot.maintain.svg) 9 | 10 | [![Instalar Wifi Hotspot con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hotspot) 11 | 12 | *[Le este README en outros idiomas.](./ALL_README.md)* 13 | 14 | > *Este paquete permíteche instalar Wifi Hotspot de xeito rápido e doado nun servidor YunoHost.* 15 | > *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* 16 | 17 | ## Vista xeral 18 | 19 | * Broadcast a Wi-Fi access point from your self-hosted server 20 | * Combine with the [VPN Client app](https://github.com/labriqueinternet/vpnclient_ynh) to obtain a VPN-protected WiFi 21 | 22 | 23 | **Versión proporcionada:** 2.3.1~ynh1 24 | 25 | ## Capturas de pantalla 26 | 27 | ![Captura de pantalla de Wifi Hotspot](./doc/screenshots/hotspot.png) 28 | 29 | ## Documentación e recursos 30 | 31 | - Web oficial da app: 32 | - Tenda YunoHost: 33 | - Informar dun problema: 34 | 35 | ## Info de desenvolvemento 36 | 37 | Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing). 38 | 39 | Para probar a rama `testing`, procede deste xeito: 40 | 41 | ```bash 42 | sudo yunohost app install https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 43 | ou 44 | sudo yunohost app upgrade hotspot -u https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 45 | ``` 46 | 47 | **Máis info sobre o empaquetado da app:** 48 | -------------------------------------------------------------------------------- /README_it.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Wifi Hotspot per YunoHost 7 | 8 | [![Livello di integrazione](https://dash.yunohost.org/integration/hotspot.svg)](https://dash.yunohost.org/appci/app/hotspot) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/hotspot.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/hotspot.maintain.svg) 9 | 10 | [![Installa Wifi Hotspot con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hotspot) 11 | 12 | *[Leggi questo README in altre lingue.](./ALL_README.md)* 13 | 14 | > *Questo pacchetto ti permette di installare Wifi Hotspot su un server YunoHost in modo semplice e veloce.* 15 | > *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.* 16 | 17 | ## Panoramica 18 | 19 | * Broadcast a Wi-Fi access point from your self-hosted server 20 | * Combine with the [VPN Client app](https://github.com/labriqueinternet/vpnclient_ynh) to obtain a VPN-protected WiFi 21 | 22 | 23 | **Versione pubblicata:** 2.3.1~ynh1 24 | 25 | ## Screenshot 26 | 27 | ![Screenshot di Wifi Hotspot](./doc/screenshots/hotspot.png) 28 | 29 | ## Documentazione e risorse 30 | 31 | - Sito web ufficiale dell’app: 32 | - Store di YunoHost: 33 | - Segnala un problema: 34 | 35 | ## Informazioni per sviluppatori 36 | 37 | Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing). 38 | 39 | Per provare la branch di `testing`, si prega di procedere in questo modo: 40 | 41 | ```bash 42 | sudo yunohost app install https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 43 | o 44 | sudo yunohost app upgrade hotspot -u https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 45 | ``` 46 | 47 | **Maggiori informazioni riguardo il pacchetto di quest’app:** 48 | -------------------------------------------------------------------------------- /README_zh_Hans.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # YunoHost 上的 Wifi Hotspot 7 | 8 | [![集成程度](https://dash.yunohost.org/integration/hotspot.svg)](https://dash.yunohost.org/appci/app/hotspot) ![工作状态](https://ci-apps.yunohost.org/ci/badges/hotspot.status.svg) ![维护状态](https://ci-apps.yunohost.org/ci/badges/hotspot.maintain.svg) 9 | 10 | [![使用 YunoHost 安装 Wifi Hotspot](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hotspot) 11 | 12 | *[阅读此 README 的其它语言版本。](./ALL_README.md)* 13 | 14 | > *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 Wifi Hotspot。* 15 | > *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* 16 | 17 | ## 概况 18 | 19 | * Broadcast a Wi-Fi access point from your self-hosted server 20 | * Combine with the [VPN Client app](https://github.com/labriqueinternet/vpnclient_ynh) to obtain a VPN-protected WiFi 21 | 22 | 23 | **分发版本：** 2.3.1~ynh1 24 | 25 | ## 截图 26 | 27 | ![Wifi Hotspot 的截图](./doc/screenshots/hotspot.png) 28 | 29 | ## 文档与资源 30 | 31 | - 官方应用网站： 32 | - YunoHost 商店： 33 | - 报告 bug： 34 | 35 | ## 开发者信息 36 | 37 | 请向 [`testing` 分支](https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing) 发送拉取请求。 38 | 39 | 如要尝试 `testing` 分支，请这样操作： 40 | 41 | ```bash 42 | sudo yunohost app install https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 43 | 或 44 | sudo yunohost app upgrade hotspot -u https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug 45 | ``` 46 | 47 | **有关应用打包的更多信息：** 48 | -------------------------------------------------------------------------------- /conf/dnsmasq_dhcpdv4.conf: -------------------------------------------------------------------------------- 1 | # Wifi Hotspot app for YunoHost 2 | 3 | # Do DHCP for this subnet. 4 | dhcp-range=interface:__WIFI_DEVICE__,__IP4_NAT_PREFIX__.2,__IP4_NAT_PREFIX__.254,4h 5 | 6 | # Send DHCPv4 option. 7 | dhcp-option=option:dns-server,__IP4_DNS__ 8 | 9 | # Set the DHCP server to authoritative mode. In this mode it will barge in 10 | # and take over the lease for any client which broadcasts on the network, 11 | # whether it has a record of the lease or not. This avoids long timeouts 12 | # when a machine wakes up on a new network. DO NOT enable this if there's 13 | # the slightest chance that you might end up accidentally configuring a DHCP 14 | # server for your campus/company accidentally. The ISC server uses 15 | # the same option, and this URL provides more information: 16 | # http://www.isc.org/files/auth.html 17 | dhcp-authoritative 18 | 19 | # On systems which support it, dnsmasq binds the wildcard address, 20 | # even when it is listening on only some interfaces. It then discards 21 | # requests that it shouldn't reply to. This has the advantage of 22 | # working even when interfaces come and go and change address. If you 23 | # want dnsmasq to really bind only the interfaces it is listening on, 24 | # uncomment this option. About the only time you may need this is when 25 | # running another nameserver on the same machine. 26 | bind-interfaces 27 | 28 | # If this line is uncommented, dnsmasq will read /etc/ethers and act 29 | # on the ethernet-address/IP pairs found there just as if they had 30 | # been given as --dhcp-host options. Useful if you keep 31 | # MAC-address/host mappings there for other purposes. 32 | #read-ethers 33 | -------------------------------------------------------------------------------- /conf/dnsmasq_dhcpdv6.conf: -------------------------------------------------------------------------------- 1 | # Do DHCP and Router Advertisements for this subnet. Set the A bit in the RA 2 | # so that clients can use SLAAC addresses as well as DHCP ones. 3 | dhcp-range=interface:__WIFI_DEVICE__,__IP6_NET__,slaac,64,4h 4 | 5 | # Send DHCPv6 option. Note [] around IPv6 addresses. 6 | dhcp-option=option6:dns-server,__IP6_DNS__ 7 | -------------------------------------------------------------------------------- /conf/hostapd.conf: -------------------------------------------------------------------------------- 1 | interface=__WIFI_DEVICE__ 2 | hw_mode=g 3 | macaddr_acl=0 4 | auth_algs=1 5 | ignore_broadcast_ssid=0 6 | channel=__WIFI_CHANNEL__ 7 | ssid=__WIFI_SSID__ 8 | __SEC_COMMENT__wpa=2 9 | __SEC_COMMENT__wpa_passphrase=__WIFI_PASSPHRASE__ 10 | __SEC_COMMENT__wpa_key_mgmt=WPA-PSK 11 | __SEC_COMMENT__wpa_pairwise=TKIP 12 | __SEC_COMMENT__rsn_pairwise=CCMP 13 | -------------------------------------------------------------------------------- /conf/openvpn_90-hotspot: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | is_nat_set() { 4 | local gateway_interface=${1} 5 | iptables -w -nvt nat -L POSTROUTING | grep MASQUERADE | grep -q "${gateway_interface}" 6 | } 7 | 8 | unset_nat() { 9 | local gateway_interface=${1} 10 | iptables -w -t nat -D POSTROUTING -o "${gateway_interface}" -j MASQUERADE 11 | } 12 | 13 | set_nat() { 14 | local gateway_interface=${1} 15 | iptables -w -t nat -A POSTROUTING -o "${gateway_interface}" -j MASQUERADE 16 | } 17 | 18 | ynh_hotspot_state=$(systemctl is-active __SERVICE_NAME__) 19 | if [[ "${ynh_hotspot_state}" == "active" || "${ynh_hotspot_state}" == "activating" ]]; then 20 | old_gateway_interface=$(yunohost app setting __APP__ gateway_interface) 21 | new_gateway_interface=$(ip route get 1.2.3.4 | awk '{ print $5; }') 22 | 23 | if [[ -n "$old_gateway_interface" ]] && [[ "$old_gateway_interface" != "$new_gateway_interface" ]] && is_nat_set "$old_gateway_interface"; then 24 | unset_nat "${old_gateway_interface}" 25 | fi 26 | 27 | if [[ -n "$new_gateway_interface" ]] && ! is_nat_set $new_gateway_interface; then 28 | set_nat "${new_gateway_interface}" 29 | fi 30 | 31 | yunohost app setting __APP__ gateway_interface --value "${new_gateway_interface}" 32 | fi 33 | -------------------------------------------------------------------------------- /conf/systemd.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=YunoHost Wifi Hotspot 3 | Requires=network.target 4 | After=network.target 5 | 6 | [Service] 7 | Type=oneshot 8 | User=root 9 | ExecStart=/usr/local/bin/__SERVICE_NAME__ start 10 | ExecStop=/usr/local/bin/__SERVICE_NAME__ stop 11 | RemainAfterExit=yes 12 | 13 | [Install] 14 | WantedBy=multi-user.target 15 | -------------------------------------------------------------------------------- /conf/systemd_hostapd.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=LSB: Advanced IEEE 802.11 management daemon 3 | After=remote-fs.target 4 | After=network-online.target 5 | Wants=network-online.target 6 | 7 | [Service] 8 | Type=simple 9 | Restart=no 10 | TimeoutSec=5min 11 | ExecStart=/usr/sbin/hostapd /etc/hostapd/__APP__/hostapd.conf 12 | ExecReload=/bin/kill -HEP $MAINPID 13 | -------------------------------------------------------------------------------- /conf/ynh-hotspot: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | # Wifi Hotspot app for YunoHost 4 | # Copyright (C) 2015 Julien Vaubourg 5 | # Contribute at https://github.com/labriqueinternet/hotspot_ynh 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU Affero General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU Affero General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU Affero General Public License 18 | # along with this program. If not, see . 19 | 20 | source /usr/share/yunohost/helpers 21 | 22 | # Functions 23 | ## State functions 24 | 25 | has_ip6delegatedprefix() { 26 | [[ -n "${ip6_net}" ]] && [[ "${ip6_net}" != "none" ]] 27 | } 28 | 29 | ip6addrfromdelegatedprefix() { 30 | echo "${ip6_net}1" 31 | } 32 | 33 | is_nat_set() { 34 | local gateway_interface=${1} 35 | iptables -w -nvt nat -L POSTROUTING | grep MASQUERADE | grep -q "${gateway_interface}" 36 | } 37 | 38 | is_ip4nataddr_set() { 39 | ip address show dev "${wifi_device}" 2>/dev/null | grep -q "${ip4_nat_prefix}.1/24" 40 | } 41 | 42 | is_ip6addr_set() { 43 | ip address show dev "${wifi_device}" 2>/dev/null | grep -q "$(ip6addrfromdelegatedprefix)/64" 44 | } 45 | 46 | is_ip6firewall_set() { 47 | ip6tables -w -nvL FORWARD | grep DROP | grep -q "${wifi_device}" 48 | } 49 | 50 | is_forwarding_set() { 51 | local ip6=$(sysctl net.ipv6.conf.all.forwarding | awk '{ print $NF; }') 52 | local ip4=$(sysctl net.ipv4.conf.all.forwarding | awk '{ print $NF; }') 53 | 54 | [[ "${ip6}" -eq 1 ]] && [[ "${ip4}" -eq 1 ]] 55 | } 56 | 57 | is_dhcpd6_running() { 58 | [[ -e "/run/dnsmasq/dnsmasq-dhcpdv6-$app.pid" ]] && ps -p $(cat "/run/dnsmasq/dnsmasq-dhcpdv6-$app.pid") > /dev/null 59 | } 60 | 61 | is_dhcpd4_running() { 62 | [[ -e "/run/dnsmasq/dnsmasq-dhcpdv4-$app.pid" ]] && ps -p $(cat "/run/dnsmasq/dnsmasq-dhcpdv4-$app.pid") > /dev/null 63 | } 64 | 65 | is_hostapd_running() { 66 | systemctl is-active "hostapd@${app}" &>/dev/null 67 | } 68 | 69 | is_other_hostapd_running() { 70 | other_hostapd_services=$(systemctl list-units --state=running hostapd@*.service | grep -v "^hostapd@$app.service") 71 | 72 | [[ -n "${other_hostapd_service}" ]] 73 | } 74 | 75 | is_running() { 76 | if has_ip6delegatedprefix; then 77 | if ! is_ip6addr_set; then 78 | return 1 79 | fi 80 | if [[ "${ip6_firewall}" -eq 1 ]] && ! is_ip6firewall_set; then 81 | return 1 82 | fi 83 | if ! is_dhcpd6_running; then 84 | return 1 85 | fi 86 | fi 87 | 88 | if ! is_ip4nataddr_set; then 89 | return 1 90 | fi 91 | 92 | if ! is_dhcpd4_running; then 93 | return 1 94 | fi 95 | 96 | if ! is_hostapd_running; then 97 | return 1 98 | fi 99 | 100 | if ! is_forwarding_set; then 101 | return 1 102 | fi 103 | 104 | if [[ -n ${new_gateway_interface} ]] && ! is_nat_set "${new_gateway_interface}"; then 105 | return 1 106 | fi 107 | 108 | return 0 109 | } 110 | 111 | ## Setters 112 | 113 | set_nat() { 114 | local gateway_interface=${1} 115 | 116 | iptables -w -t nat -A POSTROUTING -o "${gateway_interface}" -j MASQUERADE 117 | } 118 | 119 | set_ipaddr() { 120 | if ! is_ip4nataddr_set; then 121 | echo "hotspot ${wifi_device}: Set IPv4 NAT address" 122 | ip address add "${ip4_nat_prefix}.1/24" dev "${wifi_device}" 123 | fi 124 | 125 | if has_ip6delegatedprefix && ! is_ip6addr_set; then 126 | echo "hotspot ${wifi_device}: Set IPv6 address" 127 | ip address delete "$(ip6addrfromdelegatedprefix)/64" dev tun0 &>/dev/null 128 | ip address add "$(ip6addrfromdelegatedprefix)/64" dev "${wifi_device}" 129 | fi 130 | } 131 | 132 | set_ipfirewall() { 133 | # Set ipv6 firewalling 134 | if has_ip6delegatedprefix && [[ "${ip6_firewall}" -eq 1 ]] && ! is_ip6firewall_set; then 135 | echo "hotspot ${wifi_device}: Set IPv6 firewalling" 136 | ip6tables -w -A FORWARD -i "${wifi_device}" -j ACCEPT 137 | ip6tables -w -A FORWARD -o "${wifi_device}" -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT 138 | ip6tables -w -A FORWARD -o "${wifi_device}" -j DROP 139 | fi 140 | } 141 | 142 | set_forwarding() { 143 | sysctl -w net.ipv6.conf.all.forwarding=1 >/dev/null 144 | sysctl -w net.ipv4.conf.all.forwarding=1 >/dev/null 145 | } 146 | 147 | start_dhcpd() { 148 | # Run DHCPv4 server 149 | if ! is_dhcpd4_running; then 150 | echo "hotspot ${wifi_device}: Start the DHCPv4 server (dnsmasq)" 151 | dnsmasq -C /etc/dnsmasq.$app/dhcpdv4.conf -p0 -x /run/dnsmasq/dnsmasq-dhcpdv4-$app.pid 152 | fi 153 | 154 | # Run DHCPv6 server 155 | if has_ip6delegatedprefix && ! is_dhcpd6_running; then 156 | echo "hotspot ${wifi_device}: Start the NDP and DHCPv6 server (dnsmasq)" 157 | dnsmasq -C /etc/dnsmasq.$app/dhcpdv6.conf -p0 -x /run/dnsmasq/dnsmasq-dhcpdv6-$app.pid 158 | fi 159 | } 160 | 161 | configure_hostapd() { 162 | local ethaddr=$(ip link show dev "${wifi_device}" | grep link/ether | awk -F: '{ printf "02:%s:%s:%s:%s:00", $2, $3, $4, $5 }') 163 | ip link set addr "${ethaddr}" dev "${wifi_device}" 164 | } 165 | 166 | ## Unsetters 167 | 168 | unset_nat() { 169 | local gateway_interface=${1} 170 | 171 | iptables -w -t nat -D POSTROUTING -o "${gateway_interface}" -j MASQUERADE 172 | } 173 | 174 | unset_ipaddr() { 175 | if is_ip4nataddr_set; then 176 | echo "hotspot ${wifi_device}: Unset IPv4 NAT address" 177 | ip address delete "${ip4_nat_prefix}.1/24" dev "${wifi_device}" 178 | fi 179 | 180 | if has_ip6delegatedprefix && is_ip6addr_set; then 181 | echo "hotspot ${wifi_device}: Unset IPv6 address" 182 | ip address delete "$(ip6addrfromdelegatedprefix)/64" dev "${wifi_device}" 183 | fi 184 | } 185 | 186 | unset_ipfirewall() { 187 | if has_ip6delegatedprefix && [[ "${ip6_firewall}" -eq 1 ]] && is_ip6firewall_set; then 188 | echo "hotspot ${wifi_device}: Unset IPv6 firewalling" 189 | ip6tables -w -D FORWARD -i "${wifi_device}" -j ACCEPT 190 | ip6tables -w -D FORWARD -o "${wifi_device}" -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT 191 | ip6tables -w -D FORWARD -o "${wifi_device}" -j DROP 192 | fi 193 | } 194 | 195 | unset_forwarding() { 196 | sysctl -w net.ipv6.conf.all.forwarding=0 >/dev/null 197 | sysctl -w net.ipv4.conf.all.forwarding=0 >/dev/null 198 | } 199 | 200 | stop_dhcpd() { 201 | if is_dhcpd6_running; then 202 | echo "hotspot ${wifi_device}: Stop the NDP and DHCPv6 server (dnsmasq)" 203 | kill $(cat /run/dnsmasq/dnsmasq-dhcpdv6-$app.pid) 204 | rm -f /run/dnsmasq/dnsmasq-dhcpdv6-$app.pid 205 | fi 206 | 207 | if is_dhcpd4_running; then 208 | echo "hotspot ${wifi_device}: Stop the DHCPv4 server (dnsmasq)" 209 | kill $(cat /run/dnsmasq/dnsmasq-dhcpdv4-$app.pid) 210 | rm -f /run/dnsmasq/dnsmasq-dhcpdv4-$app.pid 211 | fi 212 | } 213 | 214 | stop_hostapd() { 215 | systemctl stop "hostapd@${app}" 216 | } 217 | 218 | if [ "$1" != restart ]; then 219 | 220 | # Variables 221 | 222 | echo -n "Retrieving Yunohost settings... " 223 | 224 | app=__APP__ 225 | service_enabled=$(ynh_app_setting_get --app=$app --key=service_enabled) 226 | wifi_device=$(ynh_app_setting_get --app=$app --key=wifi_device) 227 | wifi_channel=$(ynh_app_setting_get --app=$app --key=wifi_channel) 228 | 229 | wifi_ssid=$(ynh_app_setting_get --app=$app --key=wifi_ssid) 230 | wifi_secure=$(ynh_app_setting_get --app=$app --key=wifi_secure) 231 | wifi_passphrase=$(ynh_app_setting_get --app=$app --key=wifi_passphrase) 232 | ip6_firewall=$(ynh_app_setting_get --app=$app --key=ip6_firewall) 233 | ip6_dns=$(ynh_app_setting_get --app=$app --key=ip6_dns) 234 | ip6_net=$(ynh_app_setting_get --app=$app --key=ip6_net) 235 | ip4_dns=$(ynh_app_setting_get --app=$app --key=ip4_dns) 236 | ip4_nat_prefix=$(ynh_app_setting_get --app=$app --key=ip4_nat_prefix) 237 | 238 | old_gateway_interface=$(ynh_app_setting_get --app=$app --key=gateway_interface) 239 | 240 | # The awk syntax is to accomodate to the fact that the ip route output may look like: 241 | # 1.2.3.4 via 192.168.1.254 dev end0 src 192.168.1.35 uid 0 242 | # 1.2.3.4 dev vpn_iloth table 51820 src 5.6.7.8 uid 0 243 | new_gateway_interface=$(ip route get 1.2.3.4 | awk '$2 ~ /^dev$/ { print $3; } $4 ~ /^dev$/ { print $5; }') 244 | 245 | echo "OK" 246 | fi 247 | 248 | # Script 249 | 250 | case "$1" in 251 | start) 252 | if is_running; then 253 | echo "Already started" 254 | exit 0 255 | elif [[ "${service_enabled}" -eq 0 ]]; then 256 | echo "Not starting because hotspot service is disabled" 257 | exit 1 258 | fi 259 | 260 | if [[ -z "${wifi_device}" ]]; then 261 | echo "[FAIL] No wifi device selected. Make sure your wifi antenna is plugged-in / available and select it in the Hotspot admin" 262 | exit 1 263 | fi 264 | 265 | echo "[$app] Starting..." 266 | touch /tmp/.${service_name}-started 267 | 268 | # Check old state of the ipv4 NAT settings 269 | if [[ -n "${old_gateway_interface}" ]] && [[ "${new_gateway_interface}" != "${old_gateway_interface}" ]] && is_nat_set "${old_gateway_interface}"; then 270 | unset_nat "${old_gateway_interface}" 271 | fi 272 | 273 | # Set ipv4 NAT 274 | if [[ -n "${new_gateway_interface}" ]] && ! is_nat_set "${new_gateway_interface}"; then 275 | echo "Set NAT" 276 | set_nat "${new_gateway_interface}" 277 | fi 278 | 279 | # Set forwarding for ipv6 and ipv4 280 | echo "Set forwarding" 281 | set_forwarding 282 | 283 | # Run hostapd 284 | if ! is_hostapd_running; then 285 | echo "Configuring hostapd" 286 | configure_hostapd 287 | 288 | echo "Starting hostapd..." 289 | if ! systemctl start "hostapd@${app}"; then 290 | journalctl -u hostapd -n 100 --no-hostname --no-pager 291 | exit 1 292 | fi 293 | 294 | sleep 1 295 | fi 296 | 297 | set_ipaddr 298 | set_ipfirewall 299 | start_dhcpd 300 | 301 | # Update dynamic settings 302 | ynh_app_setting_set --app=$app --key=gateway_interface --value="${new_gateway_interface}" 303 | 304 | # Regen-conf dnsmasq to enable dns resolution on dnsmasq for the new interface 305 | yunohost tools regen-conf dnsmasq 306 | ;; 307 | stop) 308 | echo "[$app] Stopping..." 309 | rm -f /tmp/.${service_name}-started 310 | 311 | if ! is_other_hostapd_running; then 312 | if [[ -n "${old_gateway_interface}" ]] && is_nat_set "${old_gateway_interface}"; then 313 | echo "Unset NAT" 314 | unset_nat "${old_gateway_interface}" 315 | fi 316 | 317 | echo "Unset forwarding" 318 | unset_forwarding 319 | fi 320 | 321 | unset_ipaddr 322 | unset_ipfirewall 323 | stop_dhcpd 324 | 325 | if is_hostapd_running; then 326 | echo "Stop hostapd" 327 | stop_hostapd 328 | fi 329 | 330 | # Regen-conf dnsmasq to disable dns resolution on dnsmasq for the previous interface 331 | yunohost tools regen-conf dnsmasq 332 | ;; 333 | restart) 334 | $0 stop 335 | $0 start 336 | ;; 337 | status) 338 | exitcode=0 339 | 340 | if [[ "${service_enabled}" -eq 0 ]]; then 341 | echo "[FAIL] Hotspot Service disabled" 342 | exit 1 343 | fi 344 | 345 | if [[ -z "${wifi_device}" ]]; then 346 | echo "[FAIL] No wifi device selected. Make sure your wifi antenna is plugged-in / available and select it in the Hotspot admin" 347 | exit 1 348 | fi 349 | 350 | echo "[INFO] Autodetected internet interface: ${new_gateway_interface} (last start: ${old_gateway_interface})" 351 | 352 | if is_nat_set "${new_gateway_interface}"; then 353 | echo "[ OK ] IPv4 NAT set" 354 | else 355 | if [[ -z "${new_gateway_interface}" ]]; then 356 | echo "[INFO] No IPv4 NAT set (no internet interface)" 357 | else 358 | echo "[FAIL] No IPv4 NAT set" 359 | fi 360 | exitcode=1 361 | fi 362 | 363 | if is_forwarding_set; then 364 | echo "[ OK ] IPv6/IPv4 forwarding set" 365 | else 366 | echo "[FAIL] No IPv6/IPv4 forwarding set" 367 | exitcode=1 368 | fi 369 | 370 | if is_hostapd_running; then 371 | echo "[ OK ] Hostapd is running" 372 | else 373 | echo "[FAIL] Hostapd is not running" 374 | exitcode=1 375 | fi 376 | 377 | if has_ip6delegatedprefix; then 378 | echo "[INFO] hotspot ${wifi_device}: IPv6 delegated prefix found" 379 | echo "[INFO] hotspot ${wifi_device}: IPv6 address computed from the delegated prefix: $(ip6addrfromdelegatedprefix)" 380 | 381 | if is_ip6addr_set; then 382 | echo "[ OK ] hotspot ${wifi_device}: IPv6 address set" 383 | else 384 | echo "[FAIL] hotspot ${wifi_device}: No IPv6 address set" 385 | exitcode=1 386 | fi 387 | 388 | if is_ip6firewall_set; then 389 | echo "[ OK ] hotspot ${wifi_device}: IPv6 firewalling set" 390 | else 391 | if [[ "${ip6_firewall}" -eq 1 ]]; then 392 | echo "[FAIL] hotspot ${wifi_device}: No IPv6 firewalling set" 393 | else 394 | echo "[INFO] hotspot ${wifi_device}: No IPv6 firewalling set" 395 | fi 396 | exitcode=1 397 | fi 398 | 399 | if is_dhcpd6_running; then 400 | echo "[ OK ] hotspot ${wifi_device}: NDP and DHCPv6 server (dnsmasq) are running" 401 | else 402 | echo "[FAIL] hotspot ${wifi_device}: NDP and DHCPv6 server (dnsmasq) are not running" 403 | exitcode=1 404 | fi 405 | else 406 | echo "[INFO] hotspot ${wifi_device}: No IPv6 delegated prefix found" 407 | fi 408 | 409 | if is_dhcpd4_running; then 410 | echo "[ OK ] hotspot ${wifi_device}: DHCPv4 server (dnsmasq) is running" 411 | else 412 | echo "[FAIL] hotspot ${zifi_device}: DHCPv4 (dnsmasq) is not running" 413 | exitcode=1 414 | fi 415 | 416 | if is_ip4nataddr_set; then 417 | echo "[ OK ] hotspot ${wifi_device}: IPv4 NAT address set" 418 | else 419 | echo "[FAIL] hotspot ${wifi_device}: No IPv4 NAT address set" 420 | exitcode=1 421 | fi 422 | 423 | exit ${exitcode} 424 | ;; 425 | *) 426 | echo "Usage: $0 {start|stop|restart|status}" 427 | exit 1 428 | ;; 429 | esac 430 | 431 | exit 0 432 | -------------------------------------------------------------------------------- /config_panel.toml: -------------------------------------------------------------------------------- 1 | version = "1.0" 2 | 3 | [main] 4 | name = "Configuration" 5 | 6 | [main.service] 7 | name = "" 8 | optional = false 9 | 10 | [main.service.no_antenna] 11 | # The value is filled via a custom getter 12 | type = "boolean" 13 | visible = "false" 14 | 15 | [main.service.no_antenna_alert] 16 | ask = "No wifi antenna has been detected! If you use a wifi USB dongle and that this one is not listed here, try to unplug and replug it, then reload this page." 17 | type = "alert" 18 | style = "danger" 19 | visible = "no_antenna" 20 | 21 | [main.service.status] 22 | ask = "The status of your Hotspot is unknown." 23 | type = "alert" 24 | style = "info" 25 | visible = "! no_antenna" 26 | 27 | [main.service.service_enabled] 28 | ask = "Enable Hotspot" 29 | type = "boolean" 30 | visible = "! no_antenna" 31 | 32 | [main.service.wifi_device] 33 | ask = "Device" 34 | type = "select" 35 | choices.wlan0 = "wlan0" 36 | visible = "! no_antenna" 37 | 38 | [main.service.wifi_channel] 39 | ask = "Channel" 40 | type = "select" 41 | choices.1 = "1" 42 | choices.2 = "2" 43 | choices.3 = "3" 44 | choices.4 = "4" 45 | choices.5 = "5" 46 | choices.6 = "6" 47 | choices.7 = "7" 48 | choices.8 = "8" 49 | choices.9 = "9" 50 | choices.10 = "10" 51 | choices.11 = "11" 52 | visible = "! no_antenna" 53 | help = "Changing the channel may help with signal strength depending on neighbour WiFis" 54 | 55 | [main.hotspot] 56 | name = "Hotspot" 57 | optional = false 58 | visible = "! no_antenna" 59 | 60 | [main.hotspot.wifi_ssid] 61 | ask = "Name (SSID)" 62 | type = "string" 63 | pattern.regexp = '^[\w \-]{1,32}$' 64 | pattern.error = "SSID in this app are limited to letter, number space, dash and underscores." 65 | 66 | [main.hotspot.wifi_secure] 67 | ask = "Secure" 68 | type = "boolean" 69 | 70 | [main.hotspot.wifi_passphrase] 71 | ask = "Password (WPA2)" 72 | type = "string" 73 | redact = true 74 | optional = true 75 | visible = "wifi_secure" 76 | pattern.regexp = '^[a-zA-Z0-9]{8,63}$' 77 | pattern.error = "Only printable alphanumeric characters are permitted in your password. Maximal size 63 chars" 78 | 79 | [main.hotspot.advanced] 80 | ask = "Advanced settings" 81 | type = "boolean" 82 | 83 | [main.hotspot.ip4_nat_prefix] 84 | ask = "IPv4 NAT prefix (/24)" 85 | type = "string" 86 | visible = "advanced" 87 | pattern.regexp = '^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$' 88 | pattern.error = "Please provide a private /24 range in the format xxx.xxx.xxx" 89 | 90 | [main.hotspot.ip6_net] 91 | ask = "IPv6 delegated prefix" 92 | type = "string" 93 | optional = true 94 | visible = "advanced" 95 | pattern.regexp = '^[0-9a-fA-F:]+$' 96 | pattern.error = "Please provide a valid IPv6 Prefix" 97 | 98 | [main.hotspot.ip6_firewall] 99 | ask = "IPv6 firewall" 100 | type = "boolean" 101 | visible = "advanced" 102 | 103 | [main.hotspot.dns] 104 | ask = "DNS resolvers" 105 | type = "tags" 106 | optional = true 107 | visible = "advanced" 108 | pattern.regexp = '^([0-9.]{7,15}|[0-9a-fA-F:]+)$' 109 | pattern.error = "Not an ip" 110 | 111 | -------------------------------------------------------------------------------- /doc/DESCRIPTION.md: -------------------------------------------------------------------------------- 1 | * Broadcast a Wi-Fi access point from your self-hosted server 2 | * Combine with the [VPN Client app](https://github.com/labriqueinternet/vpnclient_ynh) to obtain a VPN-protected WiFi 3 | -------------------------------------------------------------------------------- /doc/DESCRIPTION_fr.md: -------------------------------------------------------------------------------- 1 | * Diffusez un point d'accès Wi-Fi depuis votre serveur auto-hébergé 2 | * À combiner avec l'[app VPN Client](https://github.com/labriqueinternet/vpnclient_ynh) pour obtenir un accès internet aumatiquement protégé par votre VPN 3 | -------------------------------------------------------------------------------- /doc/PRE_INSTALL.md: -------------------------------------------------------------------------------- 1 | After the installation, you will be able to configure the application from YunoHost's webadmin in Applications > Hotspot > Configuration. 2 | -------------------------------------------------------------------------------- /doc/PRE_INSTALL_fr.md: -------------------------------------------------------------------------------- 1 | Après l'application, vous pourrez configurer l'application depuis la webadmin de YunoHost dans Applications > Hotspot > Configuration. 2 | -------------------------------------------------------------------------------- /doc/screenshots/hotspot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/YunoHost-Apps/hotspot_ynh/023e82ef7fc2f7e2cdf502209d0e88b2a2054b27/doc/screenshots/hotspot.png -------------------------------------------------------------------------------- /manifest.toml: -------------------------------------------------------------------------------- 1 | #:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json 2 | 3 | packaging_format = 2 4 | 5 | id = "hotspot" 6 | name = "Wifi Hotspot" 7 | description.en = "Create and configure a WiFi hotspot" 8 | description.fr = "Créez et gérez un point d'accès WiFi" 9 | 10 | version = "2.3.1~ynh1" 11 | 12 | maintainers = [] 13 | 14 | [upstream] 15 | license = "AGPL-3.0" 16 | website = "https://internetcu.be/" 17 | 18 | [integration] 19 | yunohost = ">= 11.2.7" 20 | architectures = "all" 21 | multi_instance = true 22 | ldap = "not_relevant" 23 | sso = "not_relevant" 24 | disk = "50M" 25 | ram.build = "50M" 26 | ram.runtime = "50M" 27 | 28 | [install] 29 | [install.wifi_ssid] 30 | ask.en = "Choose a wifi name (SSID)" 31 | ask.fr = "Choisissez un nom pour le wifi (SSID)" 32 | type = "string" 33 | example = "myNeutralNetwork" 34 | default = "myNeutralNetwork" 35 | 36 | [install.wifi_passphrase] 37 | ask.en = "Choose a wifi password (at least 8 characters for WPA2)" 38 | ask.fr = "Choisissez un mot de passe wifi (au minimum 8 caractères pour le WPA2)" 39 | type = "password" 40 | 41 | [install.firmware_nonfree] 42 | ask.en = "Install non-free WiFi firmwares? (Only needed if you're using a proprietary WiFi antenna/dongle)" 43 | ask.fr = "Installer des firmwares WiFi non-libres ? (Nécessaire seulement si vous utilisez une antenne/clé WiFi propriétaire)" 44 | type = "boolean" 45 | default = false 46 | 47 | [resources] 48 | [resources.system_user] 49 | 50 | [resources.permissions] 51 | 52 | [resources.apt] 53 | packages = "sipcalc, hostapd, iw, kmod" 54 | packages_from_raw_bash = '[[ "$firmware_nonfree" -eq 0 ]] && echo "firmware-ath9k-htc" || true' 55 | 56 | [resources.apt.extras.nonfree] 57 | repo = "deb http://deb.debian.org/debian bullseye non-free" 58 | key = "https://ftp-master.debian.org/keys/archive-key-11.asc" 59 | packages_from_raw_bash = """ 60 | # Proprietary USB Wireless Device firmwares, based on https://wiki.debian.org/WiFi#USB_Devices 61 | if [[ "$firmware_nonfree" -eq 1 ]]; then 62 | # if armbian-firmware is detected, we dont include ra-link which is known to conflict.... 63 | if dpkg --list | grep -q armbian-firmware; then 64 | echo "firmware-atheros firmware-realtek firmware-libertas atmel-firmware firmware-zd1211" 65 | else 66 | echo "firmware-atheros firmware-realtek firmware-ralink firmware-libertas atmel-firmware firmware-zd1211" 67 | fi 68 | else 69 | echo " " 70 | fi""" 71 | -------------------------------------------------------------------------------- /scripts/_common.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | function other_hotspot_apps() 4 | { 5 | local app_shortname="${app%%__*}" 6 | local hotspot_apps=$(yunohost app list --output-as json | jq -r .apps[].id | grep -F $app_shortname) 7 | # Remove this app from hotspot apps list 8 | grep -F -x -v $app <<< ${hotspot_apps} 9 | } 10 | 11 | function iw_devices() 12 | { 13 | /sbin/iw dev | grep Interface | grep -v 'mon\.' | grep -v hotspot | awk '{ print $NF }' 14 | } 15 | 16 | function used_iw_devices() 17 | { 18 | for hotspot_app in $(other_hotspot_apps); do 19 | hotspot_wifi_device=$(ynh_app_setting_get --app=$hotspot_app --key=wifi_device) 20 | if [[ -n "${hotspot_wifi_device}" ]]; then 21 | echo "${hotspot_wifi_device}" 22 | fi 23 | done 24 | } 25 | 26 | function unused_iw_devices() 27 | { 28 | # Only prints devices that are not in the list of used devices 29 | iw_devices | grep -F -v -f <(used_iw_devices) 30 | } 31 | 32 | 33 | function hot_reload_usb_wifi_cards() 34 | { 35 | modulesList="acx-mac80211 ar5523 ar9170usb at76c50x-usb at76_usb ath9k_htc carl9170 orinoco_usb p54usb prism2_usb r8712u r8192s_usb r8192u_usb rndis_wlan rt2500usb rt2800usb rt2870sta rt73usb rtl8187 rtl8192cu usb8xxx vt6656_stage zd1201 zd1211rw" 36 | modprobe --quiet --remove $modulesList || true 37 | possibleUsbDevicesNeedingReload=$(dmesg | grep -Pio '(?<=usb )[0-9-]+(?=:.*firmware)' | sort | uniq) 38 | for usbPath in $possibleUsbDevicesNeedingReload; do 39 | if [[ -f "/sys/bus/usb/devices/$usbPath/authorized" ]]; then 40 | echo "Try to reload driver for usb $usbPath" >&2 41 | echo 0 > /sys/bus/usb/devices/$usbPath/authorized 42 | echo 1 > /sys/bus/usb/devices/$usbPath/authorized 43 | # Wait for driver reloading 44 | sleep 2 45 | fi 46 | done 47 | } 48 | 49 | function configure_hostapd() 50 | { 51 | if [[ "${wifi_secure}" -eq 1 ]]; then 52 | sec_comment="" 53 | else 54 | sec_comment="#" 55 | fi 56 | 57 | ynh_add_config --template="../conf/hostapd.conf" --destination="/etc/hostapd/$app/hostapd.conf" 58 | } 59 | 60 | function configure_dhcp() 61 | { 62 | ynh_add_config --template="../conf/dnsmasq_dhcpdv4.conf" --destination="/etc/dnsmasq.$app/dhcpdv4.conf" 63 | 64 | if [[ -n "${ip6_net}" ]] && [[ "${ip6_net}" != "none" ]]; then 65 | ynh_add_config --template="../conf/dnsmasq_dhcpdv6.conf" --destination="/etc/dnsmasq.$app/dhcpdv6.conf" 66 | fi 67 | } 68 | -------------------------------------------------------------------------------- /scripts/backup: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts 10 | source ../settings/scripts/_common.sh 11 | source /usr/share/yunohost/helpers 12 | 13 | #================================================= 14 | # DECLARE DATA AND CONF FILES TO BACKUP 15 | #================================================= 16 | ynh_print_info --message="Declaring files to be backed up..." 17 | 18 | #================================================= 19 | # BACKUP THE APP MAIN DIR 20 | #================================================= 21 | 22 | ynh_backup --src_path="/etc/hostapd/$app/hostapd.conf" --not_mandatory 23 | ynh_backup --src_path="/etc/dnsmasq.$app/dhcpdv6.conf" --not_mandatory 24 | ynh_backup --src_path="/etc/dnsmasq.$app/dhcpdv4.conf" --not_mandatory 25 | 26 | ynh_backup --src_path="/usr/local/bin/$service_name" 27 | 28 | ynh_backup --src_path="/etc/openvpn/scripts/route-up.d/90-$service_name" 29 | ynh_backup --src_path="/etc/openvpn/scripts/route-down.d/90-$service_name" 30 | 31 | ynh_backup --src_path="/etc/systemd/system/$service_name.service" 32 | ynh_backup --src_path="/etc/systemd/system/hostapd@$app.service" 33 | 34 | #================================================= 35 | # END OF SCRIPT 36 | #================================================= 37 | 38 | ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." 39 | -------------------------------------------------------------------------------- /scripts/config: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC STARTING 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source _common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | #================================================= 13 | # MANAGE SCRIPT FAILURE 14 | #================================================= 15 | 16 | # Exit if an error occurs during the execution of the script 17 | ynh_abort_if_errors 18 | 19 | #================================================= 20 | # SPECIFIC GETTERS FOR TOML SHORT KEY 21 | #================================================= 22 | 23 | get__no_antenna() { 24 | if [[ "$(unused_iw_devices)" == "" ]] 25 | then 26 | echo "value: true" 27 | else 28 | echo "value: false" 29 | fi 30 | } 31 | 32 | get__status() { 33 | local service_enabled=$(ynh_app_setting_get $app service_enabled) 34 | if systemctl is-active hostapd@$app -q 35 | then 36 | if [[ "$service_enabled" -eq 1 ]] 37 | then 38 | cat << EOF 39 | style: success 40 | ask: 41 | en: |- 42 | Your Hotspot is running :) 43 | EOF 44 | else 45 | cat << EOF 46 | style: warning 47 | ask: 48 | en: Your Hotspot is running, but it shouldn't ! 49 | EOF 50 | fi 51 | elif [[ "$service_enabled" -eq 1 ]] 52 | then 53 | cat << EOF 54 | style: danger 55 | ask: 56 | en: |- 57 | Your Hotspot is down ! Here are errors logged in the last 5 minutes 58 | \`\`\` 59 | $(journalctl -u hostapd@$app -n10 -o cat | sed 's/^/ /g') 60 | \`\`\` 61 | EOF 62 | else 63 | cat << EOF 64 | style: info 65 | ask: 66 | en: Your Hotspot is down as expected. 67 | EOF 68 | 69 | fi 70 | } 71 | 72 | get__wifi_device() { 73 | local unused_wifi_devices=$(unused_iw_devices) 74 | if [[ -z "${unused_wifi_devices}" ]] 75 | then 76 | echo "choices: []" 77 | else 78 | cat << EOF 79 | choices: 80 | EOF 81 | for device in $unused_wifi_devices 82 | do 83 | echo " $device: $device" 84 | done 85 | fi 86 | 87 | echo "value: '$(ynh_app_setting_get $app wifi_device)'" 88 | } 89 | 90 | get__dns() { 91 | ip6_net=$(ynh_app_setting_get --app=$app --key=ip6_net) 92 | ip6_dns=$(ynh_app_setting_get --app=$app --key=ip6_dns | tr -d '[]') 93 | ip4_nat_prefix=$(ynh_app_setting_get --app=$app --key=ip4_nat_prefix) 94 | ip4_dns=$(ynh_app_setting_get --app=$app --key=ip4_dns) 95 | 96 | if [[ -n "${ip6_net}" ]] && [[ -z "${ip6_dns}" ]]; then 97 | ip6_dns="${ip6_net}1" 98 | fi 99 | 100 | if [[ -n "${ip4_nat_prefix}" ]] && [[ -z "${ip4_dns}" ]]; then 101 | ip4_dns="${ip4_nat_prefix}.1" 102 | fi 103 | 104 | echo "value: ${ip4_dns},${ip6_dns}" 105 | } 106 | 107 | #================================================= 108 | # SPECIFIC VALIDATORS FOR TOML SHORT KEYS 109 | #================================================= 110 | 111 | validate__wifi_ssid() { 112 | if [[ -z "${wifi_ssid}" ]] 113 | then 114 | echo 'SSID required' 115 | fi 116 | } 117 | 118 | validate__wifi_passphrase() { 119 | if [[ "${wifi_secure}" == "1" ]] && [[ -z "${wifi_passphrase}" ]] 120 | then 121 | echo 'In WPA2 secure mode, you need to provide a passphrase' 122 | fi 123 | } 124 | 125 | validate__ip4_nat_prefix() { 126 | if [[ -z "${ip4_nat_prefix}" ]] 127 | then 128 | echo 'Private IPv4 nat prefix required' 129 | fi 130 | } 131 | 132 | validate__dns() { 133 | if [[ -z "$ip4_dns" ]] 134 | then 135 | echo 'IPv4 DNS required' 136 | fi 137 | if [[ -n "${ip6_net}" ]] && [[ -z "$ip6_dns" ]] 138 | then 139 | echo 'IPv6 DNS required' 140 | fi 141 | } 142 | 143 | ynh_app_config_validate() { 144 | if [[ "${advanced}" -eq 0 ]]; then 145 | # When we aren't in advanced mode, these variables must be manually declared 146 | dns="${old[dns]}" 147 | ip6_net="${old[ip6_net]}" 148 | ip4_nat_prefix="${old[ip4_nat_prefix]}" 149 | fi 150 | 151 | ip6_dns="" 152 | ip4_dns="" 153 | for ip in $(echo "${dns}" | tr ',' ' '); do 154 | if [[ "$ip" == *":"* ]]; then 155 | ip6_dns+="[$ip]," 156 | else 157 | ip4_dns+="$ip," 158 | fi 159 | done 160 | # Remove trailing , 161 | ip6_dns="${ip6_dns%%,}" 162 | ip4_dns="${ip4_dns%%,}" 163 | 164 | if [[ -n "${ip6_net}" ]] && [[ -z "${ip6_dns}" ]]; then 165 | ip6_dns="${ip6_net}1" 166 | fi 167 | 168 | if [[ -n "${ip4_nat_prefix}" ]] && [[ -z "${ip4_dns}" ]]; then 169 | ip4_dns="${ip4_nat_prefix}.1" 170 | fi 171 | 172 | _ynh_app_config_validate 173 | } 174 | 175 | #================================================= 176 | # SPECIFIC SETTERS FOR TOML SHORT KEYS 177 | #================================================= 178 | 179 | set__dns() { 180 | ynh_app_setting_set $app ip6_dns "${ip6_dns}" 181 | ynh_app_setting_set $app ip4_dns "${ip4_dns}" 182 | } 183 | 184 | #================================================= 185 | # OVERWRITING VALIDATE STEP 186 | #================================================= 187 | 188 | #================================================= 189 | # OVERWRITING APPLY STEP 190 | #================================================= 191 | ynh_app_config_apply() { 192 | service_name=$(ynh_app_setting_get --app=$app --key=service_name) 193 | 194 | # Stop vpn client 195 | ynh_print_info --message="Stopping hotspot in order to edit files" 196 | yunohost service stop $service_name 197 | 198 | _ynh_app_config_apply 199 | 200 | if [[ "${service_enabled}" -eq 1 ]]; then 201 | configure_hostapd 202 | configure_dhcp 203 | 204 | # Start hotspot 205 | ynh_print_info --message="Starting hotspot service if needed" 206 | yunohost service start $service_name 207 | else 208 | ynh_print_info --message="Cleanup hotspot config files" 209 | ynh_secure_remove --file="/etc/hostapd/$app/hostapd.conf" 210 | ynh_secure_remove --file="/etc/dnsmasq.$app/dhcpdv4.conf" 211 | ynh_secure_remove --file="/etc/dnsmasq.$app/dhcpdv6.conf" 212 | 213 | systemctl restart dnsmasq 214 | fi 215 | 216 | yunohost tools regen-conf dnsmasq 217 | } 218 | 219 | ynh_app_config_run $1 220 | -------------------------------------------------------------------------------- /scripts/install: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source _common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | service_name=ynh-$app 13 | ynh_app_setting_set --app=$app --key=service_name --value=$service_name 14 | 15 | #================================================= 16 | # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS 17 | #================================================= 18 | 19 | # FIXME : we could probably implement all these checks in manifest.toml directly ? 20 | ynh_script_progression --message="Validating installation parameters..." 21 | 22 | # Check arguments 23 | if [[ -z $wifi_ssid ]] || [[ -z $wifi_passphrase ]]; then 24 | ynh_die --message="Your Wifi Hotspot needs a name and a password" 25 | fi 26 | 27 | # Check passphrase length 28 | wifi_passphrase_length="$(wc -c <<< "${wifi_passphrase}")" 29 | if [[ $wifi_passphrase_length -lt 8 ]] || [[ $wifi_passphrase_length -gt 63 ]]; then 30 | ynh_die --message="Your password must have between 8 and 63 characters (WPA2 passphrase)" 31 | fi 32 | 33 | # Check no special characters are present in the passphrase 34 | if [[ $wifi_passphrase =~ [^[:print:]] ]]; then 35 | ynh_die --message="Only printable ASCII characters are permitted in your password (WPA2 passphrase)" 36 | fi 37 | 38 | #================================================= 39 | # STANDARD MODIFICATIONS 40 | #================================================= 41 | # FIND AND OPEN A PORT 42 | #================================================= 43 | ynh_script_progression --message="Configuring firewall..." 44 | 45 | # Update firewall for DHCP 46 | # FIXME : move to manifest.toml 47 | ynh_exec_warn_less yunohost firewall allow --no-upnp --ipv6 UDP 547 48 | ynh_exec_warn_less yunohost firewall allow --no-upnp UDP 67 49 | 50 | # Meh idk where to put this ... On RPi, by default wlan is blocked 51 | if test -e /usr/sbin/rfkill && rfkill | grep wlan | grep -q -w 'blocked' 52 | then 53 | ynh_print_info "Unblocking wlan interface..." 54 | /usr/sbin/rfkill unblock wlan 55 | fi 56 | 57 | #================================================= 58 | # SPECIFIC SETTINGS 59 | #================================================= 60 | ynh_script_progression --message="Configuring hotspot..." 61 | 62 | ip6_net="" 63 | ip6_dns="" 64 | 65 | ip4_nat_prefix_index=${app##*__} 66 | if [[ "${ip4_nat_prefix_index}" == "${app}" ]]; then 67 | ip4_nat_prefix_index=0 68 | fi 69 | ip4_nat_prefix="10.${ip4_nat_prefix_index}.242" 70 | ip4_dns="${ip4_nat_prefix}.1" 71 | 72 | hot_reload_usb_wifi_cards 73 | wifi_device=$(unused_iw_devices | head -n 1) 74 | wifi_secure=1 75 | wifi_channel=6 76 | 77 | ynh_app_setting_set --app=$app --key=wifi_secure --value="${wifi_secure}" 78 | ynh_app_setting_set --app=$app --key=wifi_device --value="${wifi_device}" 79 | ynh_app_setting_set --app=$app --key=wifi_channel --value="${wifi_channel}" 80 | ynh_app_setting_set --app=$app --key=advanced --value=0 81 | ynh_app_setting_set --app=$app --key=ip6_firewall --value=1 82 | ynh_app_setting_set --app=$app --key=ip6_net --value="${ip6_net}" 83 | ynh_app_setting_set --app=$app --key=ip6_dns --value="${ip6_dns}" 84 | ynh_app_setting_set --app=$app --key=ip4_dns --value="${ip4_dns}" 85 | ynh_app_setting_set --app=$app --key=ip4_nat_prefix --value="${ip4_nat_prefix}" 86 | 87 | if [[ -z "$wifi_device" ]]; then 88 | ynh_app_setting_set --app=$app --key=service_enabled --value=0 89 | else 90 | ynh_app_setting_set --app=$app --key=service_enabled --value=1 91 | fi 92 | 93 | # We must explicitly save the wifi passphrase despite being in the install question 94 | # because password-type questions are not saved automatically 95 | ynh_app_setting_set --app=$app --key=wifi_passphrase --value="$wifi_passphrase" 96 | 97 | #================================================= 98 | # COPY CONFIGS 99 | #================================================= 100 | ynh_script_progression --message="Copying configuration files..." 101 | 102 | mkdir -pm 0755 /etc/hostapd/$app/ 103 | chown root: /etc/hostapd/$app/ 104 | 105 | mkdir -pm 0755 /etc/dnsmasq.$app/ 106 | chown root: /etc/dnsmasq.$app/ 107 | 108 | # Copy init script 109 | ynh_add_config --template="../conf/ynh-hotspot" --destination="/usr/local/bin/$service_name" 110 | chmod 0755 "/usr/local/bin/$service_name" 111 | 112 | # Copy openvpn scripts 113 | mkdir -pm 0755 /etc/openvpn/scripts 114 | mkdir -pm 0755 /etc/openvpn/scripts/route-up.d 115 | mkdir -pm 0755 /etc/openvpn/scripts/route-down.d 116 | ynh_add_config --template="../conf/openvpn_90-hotspot" --destination="/etc/openvpn/scripts/route-up.d/90-$service_name" 117 | ynh_add_config --template="../conf/openvpn_90-hotspot" --destination="/etc/openvpn/scripts/route-down.d/90-$service_name" 118 | chmod 0755 "/etc/openvpn/scripts/route-up.d/90-${service_name}" 119 | chmod 0755 "/etc/openvpn/scripts/route-down.d/90-${service_name}" 120 | 121 | #================================================= 122 | # CONFIGURE HOSTAPD 123 | #================================================= 124 | ynh_script_progression --message="Configuring hostapd..." 125 | 126 | # Disable hostapd, we'll use hostapd@$app instead (for multissid support etc) 127 | systemctl disable hostapd --quiet 2>&1 128 | systemctl stop hostapd 2>&1 129 | systemctl mask hostapd 2>&1 130 | 131 | if [[ -n "${wifi_device}" ]]; then 132 | configure_hostapd 133 | configure_dhcp 134 | fi 135 | 136 | #================================================= 137 | # SETUP SYSTEMD 138 | #================================================= 139 | ynh_script_progression --message="Configuring systemd service..." 140 | 141 | # Create a dedicated systemd config 142 | ynh_add_systemd_config --service=$service_name 143 | # Create custom systemd config for hostapd to handle multiple wifi devices 144 | ynh_add_systemd_config --service="hostapd@$app" --template="../conf/systemd_hostapd.service" 145 | 146 | yunohost service add $service_name --description "Creates a Wi-Fi access point" --test_status "systemctl is-active hostapd@$app" --need_lock 147 | 148 | #================================================= 149 | # START SYSTEMD SERVICE 150 | #================================================= 151 | ynh_script_progression --message="Starting the hotspot..." 152 | 153 | # Start a systemd service if device is present 154 | if [[ $wifi_device == "" ]]; then 155 | echo "WARNING: Wifi Hotspot is not started because no wifi device was found (check the Hotspot configuration in the webadmin > Applications > Hotspot > the config panel)" >&2 156 | else 157 | yunohost service start $service_name 158 | fi 159 | 160 | #================================================= 161 | # END OF SCRIPT 162 | #================================================= 163 | 164 | ynh_script_progression --message="Installation of $app completed" 165 | -------------------------------------------------------------------------------- /scripts/remove: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source _common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | #================================================= 13 | # STANDARD REMOVE 14 | #================================================= 15 | # REMOVE SERVICE INTEGRATION IN YUNOHOST 16 | #================================================= 17 | 18 | # Remove the service from the list of services known by Yunohost (added from `yunohost service add`) 19 | ynh_script_progression --message="Removing $app service" 20 | yunohost service stop $service_name 21 | yunohost service remove $service_name 22 | 23 | ynh_remove_systemd_config --service=$service_name 24 | ynh_remove_systemd_config --service="hostapd@$app" 25 | 26 | #================================================= 27 | # REMOVE APP MAIN DIR 28 | #================================================= 29 | ynh_script_progression --message="Removing $app configurations..." 30 | 31 | ynh_secure_remove --file="/etc/openvpn/scripts/route-up.d/90-${service_name}" 32 | ynh_secure_remove --file="/etc/openvpn/scripts/route-down.d/90-${service_name}" 33 | ynh_secure_remove --file="/usr/local/bin/$service_name" 34 | 35 | for FILE in $(ls /tmp/.${service_name}-* 2>/dev/null); do 36 | ynh_secure_remove --file="$FILE" 37 | done 38 | 39 | # Remove confs 40 | ynh_secure_remove --file="/etc/dnsmasq.d/$app.conf" 41 | systemctl restart dnsmasq 42 | 43 | ynh_secure_remove --file="/etc/dnsmasq.$app/" 44 | ynh_secure_remove --file="/etc/hostapd/$app/" 45 | 46 | #================================================= 47 | # CLOSE A PORT 48 | #================================================= 49 | 50 | if [[ -z "$(other_hotspot_apps)" ]]; then 51 | if yunohost firewall list | grep -q "\- 547$"; then 52 | ynh_script_progression --message="Closing port 547" 53 | ynh_exec_warn_less yunohost firewall disallow TCP 547 54 | fi 55 | 56 | if yunohost firewall list | grep -q "\- 67$"; then 57 | ynh_script_progression --message="Closing port 67" 58 | ynh_exec_warn_less yunohost firewall disallow TCP 67 59 | fi 60 | fi 61 | -------------------------------------------------------------------------------- /scripts/restore: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts 10 | source ../settings/scripts/_common.sh 11 | source /usr/share/yunohost/helpers 12 | 13 | if systemctl -q is-enabled hostapd 14 | then 15 | # Disable hostapd, we'll use hostapd@$app instead (for multissid support etc) 16 | systemctl disable hostapd --quiet 2>&1 17 | systemctl stop hostapd 2>&1 18 | systemctl mask hostapd 2>&1 19 | fi 20 | 21 | #================================================= 22 | # FIND AND OPEN A PORT 23 | #================================================= 24 | ynh_script_progression --message="Configuring firewall..." 25 | 26 | # Update firewall for DHCP 27 | ynh_exec_warn_less yunohost firewall allow --no-upnp --ipv6 UDP 547 28 | ynh_exec_warn_less yunohost firewall allow --no-upnp UDP 67 29 | 30 | # Meh idk where to put this ... On RPi, by default wlan is blocked 31 | if test -e /usr/sbin/rfkill && rfkill | grep wlan | grep -q -w 'blocked' 32 | then 33 | ynh_print_info "Unblocking wlan interface..." 34 | /usr/sbin/rfkill unblock wlan 35 | fi 36 | 37 | #================================================= 38 | # STANDARD RESTORATION STEPS 39 | #================================================= 40 | 41 | ynh_script_progression --message="Restoring configurations ..." 42 | 43 | ynh_restore 44 | 45 | yunohost service add "$service_name" --description "Creates a Wi-Fi access point" --test_status "systemctl is-active hostapd@$app" --need_lock 46 | 47 | #================================================= 48 | # START SYSTEMD SERVICE 49 | #================================================= 50 | ynh_script_progression --message="Starting the hotspot service..." 51 | 52 | hot_reload_usb_wifi_cards 53 | if [[ -z "${wifi_device:-}" ]] || ! grep -q -F "$wifi_device" <(unused_iw_devices); then 54 | wifi_device=$(unused_iw_devices | head -n 1) 55 | ynh_app_setting_set --app=$app --key=wifi_device --value="${wifi_device}" 56 | fi 57 | 58 | if [[ -z "${wifi_device:-}" ]]; then 59 | ynh_app_setting_set --app=$app --key=service_enabled --value=0 60 | else 61 | ynh_app_setting_set --app=$app --key=service_enabled --value=1 62 | fi 63 | 64 | # Start a systemd service if device is present 65 | if [[ "${wifi_device:-}" == "" ]]; then 66 | echo "WARNING: Wifi Hotspot is not started because no wifi device was found (please, check the web admin)" >&2 67 | else 68 | yunohost service start $service_name 69 | fi 70 | 71 | #================================================= 72 | # END OF SCRIPT 73 | #================================================= 74 | 75 | ynh_script_progression --message="Restoration completed for $app" 76 | -------------------------------------------------------------------------------- /scripts/upgrade: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source _common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | upgrade_type=$(ynh_check_app_version_changed) 13 | 14 | #================================================= 15 | # STANDARD UPGRADE STEPS 16 | #================================================= 17 | # STOP SYSTEMD SERVICE 18 | #================================================= 19 | ynh_script_progression --message="Stopping the hotspot service ... (this may take some time)" 20 | yunohost service stop $service_name 21 | 22 | #================================================= 23 | # ENSURE DOWNWARD COMPATIBILITY 24 | #================================================= 25 | ynh_script_progression --message="Ensuring downward compatibility..." 26 | 27 | if [ -d /var/www/wifiadmin/ ]; then 28 | ynh_secure_remove /var/www/wifiadmin/ 29 | fi 30 | 31 | if [ -e /etc/dnsmasq.d/$app.conf ]; then 32 | ynh_secure_remove /etc/dnsmasq.d/$app.conf 33 | fi 34 | 35 | if [ ${firmware_nonfree:-} = "yes" ]; then 36 | firmware_nonfree=1 37 | ynh_app_setting_set --app=$app --key=firmware_nonfree --value=$firmware_nonfree 38 | elif [ ${firmware_nonfree:-} = "no" ]; then 39 | firmware_nonfree=0 40 | ynh_app_setting_set --app=$app --key=firmware_nonfree --value=$firmware_nonfree 41 | fi 42 | 43 | if [ -z ${service_name:-} ]; then 44 | service_name="ynh-$app" 45 | ynh_app_setting_set --app=$app --key=service_name --value=$service_name 46 | fi 47 | 48 | if [[ -n "${multissid:-}" ]] && [[ "${multissid}" -gt 1 ]]; then 49 | wifi_ssid=$(cut -d'|' -f 1 <<< ${wifi_ssid}) 50 | wifi_secure=$(cut -d'|' -f 1 <<< ${wifi_secure}) 51 | wifi_passphrase=$(cut -d'|' -f 1 <<< ${wifi_passphrase}) 52 | advanced=$(cut -d'|' -f 1 <<< ${advanced}) 53 | ip4_nat_prefix=$(cut -d'|' -f 1 <<< ${ip4_nat_prefix}) 54 | ip6_net=$(cut -d'|' -f 1 <<< ${ip6_net}) 55 | ip6_firewall=$(cut -d'|' -f 1 <<< ${ip6_firewall}) 56 | dns=$(cut -d'|' -f 1 <<< ${dns}) 57 | 58 | ynh_app_setting_set --app=$app --key=wifi_ssid --value="${wifi_ssid}" 59 | ynh_app_setting_set --app=$app --key=wifi_secure --value="${wifi_secure}" 60 | ynh_app_setting_set --app=$app --key=wifi_passphrase --value="${wifi_passphrase}" 61 | ynh_app_setting_set --app=$app --key=ip4_nat_prefix --value="${ip4_nat_prefix}" 62 | ynh_app_setting_set --app=$app --key=ip6_net --value="${ip6_net}" 63 | ynh_app_setting_set --app=$app --key=ip6_firewall --value="${ip6_firewall}" 64 | fi 65 | 66 | if [[ -n "${dns:-}" ]]; then 67 | ip6_dns="" 68 | ip4_dns="" 69 | for ip in $(echo "${dns}" | tr ',' ' '); do 70 | if [[ "$ip" == *":"* ]]; then 71 | ip6_dns+="[$ip]," 72 | else 73 | ip4_dns+="$ip," 74 | fi 75 | done 76 | # Remove trailing , 77 | ip6_dns="${ip6_dns%%,}" 78 | ip4_dns="${ip4_dns%%,}" 79 | 80 | if [[ -z "$(ynh_app_setting_get --app=$app --key=ip6_dns)" ]]; then 81 | ynh_app_setting_set --app=$app --key=ip6_dns --value="${ip6_dns}" 82 | fi 83 | if [[ -z "$(ynh_app_setting_get --app=$app --key=ip4_dns)" ]]; then 84 | ynh_app_setting_set --app=$app --key=ip4_dns --value="${ip4_dns}" 85 | fi 86 | 87 | ynh_app_setting_delete $app dns 88 | fi 89 | 90 | if [[ -n "${multissid:-}" ]]; then 91 | ynh_app_setting_delete --app=$app --key=multissid 92 | 93 | ynh_secure_remove --file="/etc/hostapd/hostapd.conf" 94 | ynh_secure_remove --file="/etc/hostapd/hostapd.base.conf" 95 | ynh_secure_remove --file="/etc/hostapd/hostapd.accesspoint.conf" 96 | ynh_secure_remove --file="/etc/dnsmasq.dhcpd/" 97 | fi 98 | 99 | if [[ -z "${advanced:-}" ]]; then 100 | ynh_app_setting_set --app=$app --key=advanced --value=0 101 | fi 102 | 103 | # Old stuff prior to 2.x 104 | 105 | if [ "${ip6_net:-}" == "none" ] 106 | then 107 | ip6_net="" 108 | ynh_app_setting_set --app=$app --key=ip6_net --value="$ip6_net" 109 | fi 110 | 111 | if [ -f /etc/nginx/conf.d/*.d/$app.conf ]; then 112 | ynh_secure_remove /etc/nginx/conf.d/*.d/$app.conf 113 | ynh_systemd_action --service_name=nginx --action=reload 114 | fi 115 | 116 | for php_path in $(ls /etc/php/*/fpm/pool.d/$app.conf 2> /dev/null); do 117 | ynh_secure_remove $php_path 118 | done 119 | 120 | if [ -d /var/www/$app ]; then 121 | ynh_secure_remove /var/www/$app 122 | fi 123 | 124 | [ -z "${domain:-}" ] || ynh_app_setting_delete $app domain 125 | [ -z "${path:-}" ] || ynh_app_setting_delete $app path 126 | [ -z "${install_dir:-}" ] || ynh_app_setting_delete $app install_dir 127 | 128 | if [ -e "/etc/sudoers.d/${app}_ynh" ]; then 129 | ynh_secure_remove "/etc/sudoers.d/${app}_ynh" 130 | fi 131 | 132 | if systemctl -q is-enabled hostapd 133 | then 134 | # Disable hostapd, we'll use hostapd@$app instead (for multissid support etc) 135 | systemctl disable hostapd --quiet 2>&1 136 | systemctl stop hostapd 2>&1 137 | systemctl mask hostapd 2>&1 138 | fi 139 | 140 | #================================================= 141 | # SPECIFIC UPGRADE 142 | #================================================= 143 | # COPY CONFIGS 144 | #================================================= 145 | ynh_script_progression --message="Copying configuration..." 146 | 147 | hot_reload_usb_wifi_cards 148 | 149 | if [[ -z "$wifi_device" ]] || ! grep -q -F "$wifi_device" <(unused_iw_devices); then 150 | wifi_device="$(unused_iw_devices | head -n 1)" 151 | ynh_app_setting_set --app=$app --key=wifi_device --value="${wifi_device}" 152 | fi 153 | 154 | mkdir -pm 0755 /etc/hostapd/$app/ 155 | chown root: /etc/hostapd/$app/ 156 | 157 | mkdir -pm 0755 /etc/dnsmasq.$app/ 158 | chown root: /etc/dnsmasq.$app/ 159 | 160 | if [[ -n "${wifi_device:-}" ]]; then 161 | configure_hostapd 162 | configure_dhcp 163 | ynh_app_setting_set --app=$app --key=service_enabled --value=1 164 | else 165 | ynh_app_setting_set --app=$app --key=service_enabled --value=0 166 | wifi_device="" 167 | fi 168 | 169 | # Copy init script 170 | ynh_add_config --template="../conf/ynh-hotspot" --destination="/usr/local/bin/$service_name" 171 | chmod 0755 "/usr/local/bin/$service_name" 172 | 173 | # Copy openvpn scripts 174 | mkdir -pm 0755 /etc/openvpn/scripts 175 | mkdir -pm 0755 /etc/openvpn/scripts/route-up.d 176 | mkdir -pm 0755 /etc/openvpn/scripts/route-down.d 177 | ynh_add_config --template="../conf/openvpn_90-hotspot" --destination="/etc/openvpn/scripts/route-up.d/90-$service_name" 178 | ynh_add_config --template="../conf/openvpn_90-hotspot" --destination="/etc/openvpn/scripts/route-down.d/90-$service_name" 179 | chmod 0755 "/etc/openvpn/scripts/route-up.d/90-${service_name}" 180 | chmod 0755 "/etc/openvpn/scripts/route-down.d/90-${service_name}" 181 | 182 | #================================================= 183 | # SETUP SYSTEMD 184 | #================================================= 185 | ynh_script_progression --message="Upgrading systemd configuration..." 186 | 187 | # Create a dedicated systemd config 188 | ynh_add_systemd_config --service=$service_name 189 | # Create custom systemd config for hostapd to handle multiple wifi devices 190 | ynh_add_systemd_config --service="hostapd@$app" --template="../conf/systemd_hostapd.service" 191 | 192 | yunohost service add $service_name --description "Creates a Wi-Fi access point" --test_status "systemctl is-active hostapd@$app" --need_lock 193 | 194 | #================================================= 195 | # START SYSTEMD SERVICE 196 | #================================================= 197 | ynh_script_progression --message="Starting the hotspot service..." 198 | 199 | # Start a systemd service if device is present 200 | if [[ $wifi_device == "" ]]; then 201 | echo "WARNING: Wifi Hotspot is not started because no wifi device was found (check the Hotspot configuration in the webadmin > Applications > Hotspot > the config panel)" >&2 202 | else 203 | yunohost service start $service_name 204 | fi 205 | 206 | #================================================= 207 | # END OF SCRIPT 208 | #================================================= 209 | 210 | ynh_script_progression --message="Upgrade of $app completed" 211 | -------------------------------------------------------------------------------- /tests.toml: -------------------------------------------------------------------------------- 1 | test_format = 1.0 2 | 3 | [default] 4 | 5 | args.wifi_passphrase = "!abcDEF01234" 6 | args.firmware_nonfree = "no" 7 | 8 | test_upgrade_from.539a1f26.name = "Pre 2.0" 9 | test_upgrade_from.539a1f26.args.domain = "domain.tld" 10 | test_upgrade_from.539a1f26.args.wifi_passphrase = "!abcDEF01234" 11 | 12 | [with_nonfree] 13 | 14 | args.wifi_passphrase = "!abcDEF01234" 15 | args.firmware_nonfree = "yes" 16 | only = ["install.nourl"] 17 | --------------------------------------------------------------------------------