mirror of
https://github.com/searx/searx
synced 2025-02-23 07:07:42 +01:00
133 lines
6.1 KiB
HTML
133 lines
6.1 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>How to contribute — searx 0.8.0 documentation</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: '../',
|
||
|
|
VERSION: '0.8.0',
|
||
|
|
COLLAPSE_INDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||
|
|
<link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
|
||
|
|
<link rel="next" title="Installation" href="install/installation.html" />
|
||
|
|
<link rel="prev" title="Search syntax" href="../user/search_syntax.html" />
|
||
|
|
|
||
|
|
|
||
|
|
<link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body role="document">
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body" role="main">
|
||
|
|
|
||
|
|
<div class="section" id="how-to-contribute">
|
||
|
|
<h1>How to contribute<a class="headerlink" href="#how-to-contribute" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="prime-directives-privacy-hackability">
|
||
|
|
<h2>Prime directives: Privacy, Hackability<a class="headerlink" href="#prime-directives-privacy-hackability" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Searx has 2 prime directives, privacy-by-design and hackability. The
|
||
|
|
hackability comes in at least 3 levels:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>support for search engines</li>
|
||
|
|
<li>plugins for altering search behaviour</li>
|
||
|
|
<li>hacking searx itself.</li>
|
||
|
|
</ul>
|
||
|
|
<p>Happy hacking. Observe the lack of “world domination” among the
|
||
|
|
directives, searx has no intentions for wide mass-adoption, rounded
|
||
|
|
corners, etc. The prime directive: “privacy” - deserves a seperate
|
||
|
|
chapter, as it’s quite uncommon unfortunately, here it goes:</p>
|
||
|
|
<div class="section" id="privacy-by-design">
|
||
|
|
<h3>Privacy-by-design<a class="headerlink" href="#privacy-by-design" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>Searx is a privacy-respecting, hackable meta-search engine. It was born
|
||
|
|
out of the need for a privacy-respecing search facility that can be
|
||
|
|
expanded easily to maximise both its search and it’s privacy protecting
|
||
|
|
capabilities.</p>
|
||
|
|
<p>Consequences of Privacy-by-design are that some widely used features
|
||
|
|
work differently or not by default or at all. If some feature reduces
|
||
|
|
the privacy perserving aspects of searx, it should by default be
|
||
|
|
switched of, if implemented at all. There is enough search engines
|
||
|
|
already out there providing such features. = Since privacy-preservation
|
||
|
|
is a prime goal, if some feature does reduce the protection of searx and
|
||
|
|
is implemented, care should be taken to educate the user about the
|
||
|
|
consequences of choosing to enable this. Further features which
|
||
|
|
implement widely known features in a manner that protects privacy but
|
||
|
|
thus deviate from the users expectations should also be explained to the
|
||
|
|
user. Also if you think that something works weird with searx, maybe
|
||
|
|
it’s because of the tool you use is designed in a way to interfere with
|
||
|
|
privacy respect, submiting a bugreport to the vendor of the tool that
|
||
|
|
misbehaves might be a good feedback for the vendor to reconsider his
|
||
|
|
disrespect towards his customers (e.g. GET vs POST requests in various
|
||
|
|
browsers).</p>
|
||
|
|
<p>Remember the other prime directive of searx is to be hackable, so if the
|
||
|
|
above privacy concerns do not fancy you, simply fork it.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="code">
|
||
|
|
<h2>Code<a class="headerlink" href="#code" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Code modifications are accepted in pull requests, don’t forget to add
|
||
|
|
yourself to the AUTHORS file.</p>
|
||
|
|
<p>Python code follows all the pep8 standards except maximum line width
|
||
|
|
which is 120 char.</p>
|
||
|
|
<p>Please be sure that the submitted code doesn’t break existing tests and
|
||
|
|
follows coding conventions.</p>
|
||
|
|
<p>If new functionality implemented, tests are highly appreciated.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="translation">
|
||
|
|
<h2>Translation<a class="headerlink" href="#translation" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Translation currently happens on
|
||
|
|
<a class="reference external" href="https://transifex.com/projects/p/searx">transifex</a>. Please do not
|
||
|
|
update translation files in the repo.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="documentation">
|
||
|
|
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>The main place of the documentation is this wiki, updates are welcome.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
|
|
<div class="sphinxsidebarwrapper"><div class="sidebar_container body">
|
||
|
|
<h1>Searx</h1>
|
||
|
|
<ul>
|
||
|
|
<li><a href="../index.html">Home</a></li>
|
||
|
|
<li><a href="https://github.com/asciimoo/searx">Source</a></li>
|
||
|
|
<li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
|
||
|
|
<li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<ul>
|
||
|
|
<li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
|
||
|
|
<li><a href="https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software">Flattr</a></li>
|
||
|
|
<li><a href="https://gratipay.com/searx">Gratipay</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2015, Adam Tauber.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|