Code Monkey home page Code Monkey logo

searx-instances's Introduction

For SearXNG instance operators

For reviewers

Add a new instance to the public list

  • create a virtualenv, and then install searxinstances:

python -m pip install .[update]

  • then searxinstances can help to edit instances.yml :
usage: searxinstances [-h] [--github-issues [GITHUB_ISSUE_LIST [GITHUB_ISSUE_LIST ...]]] [--add [ADD_INSTANCES [ADD_INSTANCES ...]]] [--delete [DELETE_INSTANCES [DELETE_INSTANCES ...]]] [--edit [EDIT_INSTANCES [EDIT_INSTANCES ...]]]

Update the instance list according to the github issues.

optional arguments:
  -h, --help            show this help message and exit
  --github-issues [GITHUB_ISSUE_LIST [GITHUB_ISSUE_LIST ...]]
                        Github issue number to process, by default all
  --add [ADD_INSTANCES [ADD_INSTANCES ...]]
                        Add instance(s)
  --delete [DELETE_INSTANCES [DELETE_INSTANCES ...]]
                        Delete instance(s)
  --edit [EDIT_INSTANCES [EDIT_INSTANCES ...]]
                        Edit instance(s)

The tool :

  • is only an helper. instances.yml can be edited directly.
  • shows the default editor to only edit one instance at a time.
  • once the user quits the editor, the script checks everything is okay, if not it goes back to the editor with the error added at the end of the buffer.
  • if everything is okay, the script modifies the instances.yml file.
  • then it creates a commit.
  • The --github-issues options reads the github issues.

An example what is shown in the default editor:

https://nibblehole.com: {}

# Add https://nibblehole.com
#
# Close https://github.com/searxng/searx-instances/issues/2
# From @dalf

#> The above text is the commit message
#> Delete the whole buffer to cancel the request

#> -- MESSAGE -----------------------
#> See https://github.com/searxng/ ...

Here is it possible to modify the yaml, the commit message and validate or delete the whole buffer to cancel.

Add a new instance to be tracked for their uptime without adding it on the public list

Add the website on https://github.com/searxng/searx-instances-uptime/blob/master/.upptimerc-custom.yml

searx-instances's People

Contributors

bauruine avatar dalf avatar decatec avatar dependabot[bot] avatar hlfh avatar ononoki1 avatar pofilo avatar return42 avatar samuel-p avatar tiekoetter avatar unixfox avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.