Difference between pages "Lyon 2017" and "Kiwix-serve"

(Difference between pages)
Jump to navigation Jump to search
Remove things about external index
 
(Remove things about external index)
 
Line 1: Line 1:
This page summarizes the action plan for the '''Kiwix Spring Hackathon 2017'''.
{{translations}}
[[File:Kiwix_0.9_rc2_article_served_en_screenshot.png|right|thumb|<translate><!--T:1-->
Kiwix-serve, embedded in Kiwix, on a Microsoft Windows computer</translate>]]
[[File:Two_kiwix-plugs.jpg|right|thumb|<translate><!--T:2-->
With [[Kiwix-plug]], kiwix-serve runs on pretty small hardwares</translate>]]


== Goals ==
<translate><!--T:3-->
* Setup the Android automated testing up and make a proof of concept
'''Kiwix-serve is a ZIM compatible Web server.''' With its help you can deliver ZIM file content over your network.</translate>
* Fix Gutenberg scrapper and generate new ZIM files
* Create a fully automatized solution for Stackexchange projects ZIM files
* Launch the first pure HTML ZIM read browser extension
* Launch CI for Kiwix repos
* Implement Wikimed Feedback solution
* Implement Wikihow scrapper (non-parsoid Mediawiki scraper)
* Fix fulltext search/indexes problems
* Use node-libzim instead of zimwriterfs in mwoffliner
* Implement a solution to allow non-tech to launch/update Android custom apps
* Release a new version of Kiwix for Android


== Achievements ==
<translate><!--T:4-->
Based on the well known HTTP protocol, kiwix-serve allows you to share the [[Special:MyLanguage/Wikipedia_in_all_languages|ZIM files available]] on your computer easily with others connected to your network. You simply need to start kiwix-serve and your content will be available for anybody through their own Web browser.</translate>


== Impact ==
<translate><!--T:5-->
Kiwix-serve is a good solution if you have a LAN network and don't want to install Kiwix on all computers. It's a good alternative if you don't have a shared network disk from which everybody can start Kiwix.</translate>


This hackathon gathers different kind of tasks which all in one will help to implement the Wikimed Projet and reach our goals in term of new content for 2017.
== <translate><!--T:6-->
Features</translate> ==
<translate><!--T:7-->
Kiwix-serve has not so many features like Kiwix, but provides the most important ones:
* Full text search engine
* Search suggestions
* Really small and efficient
* Compatible with almost all browsers
* Available on all platforms
* Available as command line executable
* Embedded in Kiwix UI
* Able to deal with one ZIM file or XML library files</translate>


== Method ==
== <translate><!--T:8-->
Get it</translate> ==
<translate><!--T:9-->
On Microsoft Windows, Apple Mac OS X and GNU/Linux, kiwix-serve is packaged and distributed with Kiwix. You simply need to [[Special:MyLanguage/Software|download the Kiwix installer corresponding to your Operating System]].</translate>


~ 8 developers meet during a week to make this steps forward.
<translate><!--T:10-->
We newly provide kiwix-serve as part of the Kiwix tools and [https://download.kiwix.org/release/kiwix-tools/ pre-compiled binaries for many systems are available].</translate>


== Place ==
<translate><!--T:11-->
For other systems, you will have to [[compilation|download and compile kiwix-serve source code on your own]].</translate>


The hackathon will take place in Lyon, France
== <translate><!--T:12-->
Use it</translate> ==
<translate><!--T:13-->
Kiwix-serve is directly available in the Kiwix menu "Tools > server", but for people wanting to use it from the command line, here is how it works.</translate>


== Agenda ==
<translate><!--T:14-->
Prerequisites:
* kiwix-serve binary, available in the Kiwix application directory
* A ZIM file or a library file (you can use the library.xml file available in your Kiwix data directory).</translate>


* April 2th afternoon: arrivals (suggested arrival time 5PM)
<translate><!--T:15-->
* April 3th -> 9th: Kiwix hackathon
Unix command line (just use kiwix-serve.exe on Microsoft Windows) example to start kiwix-serve with an XML library file:
* April 9th afternoon: departures (suggested arrival time 3PM)
<source lang="bash">
kiwix-serve --library ~/.www.kiwix.org/kiwix/efrnsupg.default/data/library/library.xml
</source></translate>


== People ==
<translate><!--T:16-->
Unix command line example to start kiwix-serve with a ZIM file:
<source lang="bash">
kiwix-serve --port=8080 wikipedia.zim
</source></translate>


; Travel + Accomodation
<translate><!--T:17-->
* Adrian
Once kiwix-serve is started, anyone with access to this computer over the network, will be able to connect to it. You need to retrieve the IP (xxx.xxx.xxx.xxx) of your computer and remember the port (per default 80) you have used and then people will only have to type in their browser address bar:
* Elad
<source lang="bash">
* Emmanuel
http://xxx.xxx.xxx.xxx:80/
* Joe
</source></translate>
* Julian
* Rashiq
* Renaud


; Only Travel
== <translate><!--T:18-->
* Isaac
Options</translate> ==
<translate><!--T:19-->
Kiwix-serve provides a few options:
* --port=PORT to specify the port you want to open for listening (per default 80)
* --daemon to execute the software in background
* --attachToProcess=PID to attach kiwix-serve process to other process
* --verbose to get a few logs</translate>


; Located in Lyon
== <translate><!--T:21-->
* Matthieu
See also</translate> ==
* Boris
<translate><!--T:22-->
 
* [[kiwix-manage]]
; Maybe
* [[kiwix-plug]]</translate>
* Benjamin
* [http://kv5r.com/computers/offline-dictionary-server/ How-to setup kiwix.exe as a Windows service]
* Souradip
 
== Costs ==
 
~5.000 CHF/USD

Navigation menu