From d91a7edc738f06f53b221c4ce14bbaaf08072e8c Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 13 May 2018 01:02:15 +0200 Subject: [PATCH 01/11] refactor CONTRIBUTING.md and PULL_REQUEST_TEMPLATE.md deduplicate information, make sure all addition rules are listed in the PR template --- .github/CONTRIBUTING.md | 24 +++++++++++------------- .github/PULL_REQUEST_TEMPLATE.md | 7 ++++--- 2 files changed, 15 insertions(+), 16 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3fe7c909..a13935ca 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,16 +1,14 @@ ## Contributing -Please join us on [chat](https://chat.awesh.unknownplus.com/channel/awesome-selfhosted) to clarify any questions. +Please join us on [chat](https://chat.awesh.unknownplus.com/channel/awesome-selfhosted) or open a new issue to clarify any questions. + +All guidelines for adding new software to the list are listed in [PULL_REQUEST_TEMPLATE.md](PULL_REQUEST_TEMPLATE.md). + +Other recommendations: + +- To add a new entry, [edit the README.md file](https://github.com/Kickball/awesome-selfhosted/edit/master/README.md) through Github's web interface or a text editor, and send a Pull Request. +- See [Editing files in another user's repository](https://help.github.com/articles/editing-files-in-another-user-s-repository/), [Creating Pull Requests](https://help.github.com/articles/creating-a-pull-request/), [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) for help on sending your patch. +- A script to help you format new entries is available at (it requires `make` to be installed): `git clone`/[download](https://github.com/Kickball/awesome-selfhosted/archive/master.zip) and enter the repository, run `make add` and follow the instructions. +- The list of contributors can be updated with `make contrib`. +- Software with no development activity for 6-12 months may be removed from the list. - * The **syntax** for links is ``- [Name](http://homepage/) - Short description. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code)) `License` `Language` ``. - * All projects must have their **license** and main server-side **language**/platform/requirement listed - * Project descriptions must be less than 250 characters long. - * Entries must be ordered alphabetically. - * Entries in README.md must be [Free Software](https://en.wikipedia.org/wiki/Free_software). - * Non-[Free](https://en.wikipedia.org/wiki/Free_software) software must be marked `⊘ Proprietary` next to the title, and added to [non-free.md](../non-free.md). - * To **add an entry**: clone/[download](https://github.com/Kickball/awesome-selfhosted/archive/master.zip) and enter the repository, run `make add` and follow the instructions; or [edit the README.md file](https://github.com/Kickball/awesome-selfhosted/edit/master/README.md) directly. See [Editing files in another user's repository](https://help.github.com/articles/editing-files-in-another-user-s-repository/), [Creating Pull Requests](https://help.github.com/articles/creating-a-pull-request/), [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) for help on sending your patch. - * A minimum of 3 entries are required to start a new category, otherwise add to the Misc/Other category. - * The `⚠` character must be inserted for software that relies on a third party service the user does not control, e.g ``[Name](http://homepage/) `⚠` - Short description...``. - * Check current [issues](https://github.com/Kickball/awesome-selfhosted/issues) and [Pull Requests](https://github.com/Kickball/awesome-selfhosted/pulls), as well as [closed issues/PRs](https://github.com/Kickball/awesome-selfhosted/pulls?utf8=%E2%9C%93&q=is%3Aclosed+). - * The list of contributors can be updated with `make contrib`. - * Software with no development activity for 6-12 months may be removed from the list. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5641f828..25cbbbef 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,9 +7,10 @@ To ensure your PR is dealt with swiftly please check the following: ``- [Name](http://homepage/) - Short description, less than 250 characters. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code)) `License` `Language` `` - [ ] Your additions are ordered alphabetically. -- [ ] Your additions are [Free software](https://en.wikipedia.org/wiki/Free_software), or if not they have been added to [non-free](non-free.md). +- [ ] Your additions are [Free software](https://en.wikipedia.org/wiki/Free_software), or if not they have been added to [non-free](non-free.md) and marked `⊘ Proprietary`. - [ ] Your additions are not already listed at [awesome-sysadmin](https://github.com/n1trux/awesome-sysadmin) (IT infrastructure management), [staticgen.com](https://www.staticgen.com/) or [staticsitegenerators.net](https://staticsitegenerators.net/) (static site generators). +- [ ] Your additions have their `License` main server-side `Language`/platform/requirement listed. - [ ] Any licenses you have added are in our [list of licenses](https://github.com/Kickball/awesome-selfhosted/blob/master/README.md#list-of-licenses). -- [ ] You have searched the repository for any relevant [issues](https://github.com/Kickball/awesome-selfhosted/issues) or [PRs](https://github.com/Kickball/awesome-selfhosted/pulls). -- [ ] Any category you are creating has the minimum requirement of 3 items. +- [ ] You have searched the repository for any relevant [issues](https://github.com/Kickball/awesome-selfhosted/issues) or [PRs](https://github.com/Kickball/awesome-selfhosted/pulls), incluing closed ones. +- [ ] Any category you are creating has the minimum requirement of 3 items. If not, your addition may be inserted into `Misc/Other`. - [ ] Any software project you are adding to the list is actively maintained. \ No newline at end of file From 69e42a98f76ac3fc3be9f43e7c2e2b7a5be111c7 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 13 May 2018 01:03:21 +0200 Subject: [PATCH 02/11] dangerfile, makefile: add documentation links, intentation fixes --- Dangerfile | 7 +++++-- Makefile | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/Dangerfile b/Dangerfile index 86adae6c..115931df 100644 --- a/Dangerfile +++ b/Dangerfile @@ -1,4 +1,7 @@ -#Check for changes to README.md +# Danger CI configuration file +# https://danger.systems/guides/getting_started.html + +# Check for changes to README.md has_readme_changes = git.modified_files.include?("README.md") # Ensure there is a summary for a pull request @@ -8,7 +11,7 @@ fail 'Please provide a summary in the Pull Request description' if github.pr_bod warn 'Please check PR guidelines and check the boxes.' if github.pr_body.include? '- [ ]' # Warn if pull request is not updated -warn 'Please update the Pull Request title to contain the script name' if github.pr_title.include? 'Update README.md' +warn 'Please provide a descriptive title for the Pull Request' if github.pr_title.include? 'Update README.md' # Warn when there are merge commits in the diff warn 'Please rebase to get rid of the merge commits in this Pull Request' if git.commits.any? { |c| c.message =~ /^Merge branch 'master'/ } diff --git a/Makefile b/Makefile index 4886ccea..d5676eaf 100755 --- a/Makefile +++ b/Makefile @@ -26,7 +26,7 @@ listlicenses: @sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep --only-matching '([Aa0-Zz9]|\s|\.|-)*` `' README.md | sort --unique syntaxerrors: - @echo -e "\n Syntax errors:" + @echo -e "\nSyntax errors:" @! sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep '\)\(|``|\)`' contrib: From e645c56a86591c70986dee9f0295099af557944c Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 13 May 2018 01:03:55 +0200 Subject: [PATCH 03/11] README: remove broken link to old rocket.chat instance the updated link is already available in CONTRIBUTING.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index fcf1674c..acd96bfa 100644 --- a/README.md +++ b/README.md @@ -1389,7 +1389,6 @@ See also [Documentation Generators](#documentation-generators), [Wikimatrix](htt **[`^ back to top ^`](#)** -- [Awesome Selfhosted Chat](https://chat.awesome-selfhosted.com) - Rocket.chat instance setup for the awesome selfhosted community. - [Awesome Big Data](https://github.com/onurakpolat/awesome-bigdata) - Curated list of awesome big data frameworks, resources and other awesomeness. - [Awesome Sysadmin](https://github.com/n1trux/awesome-sysadmin) - Curated list of amazingly awesome open source sysadmin resources. - [PRISM Break](https://prism-break.org/en/), [privacytools.io](https://www.privacytools.io/), [Alternative Internet](https://redecentralize.github.io/alternative-internet/), [Libre Projects](http://libreprojects.net/) - Lists of software aimed at privacy and decentralization (in some form). From 5c4a0c753cdb6d3f937b92459a5b867582d422e4 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 13 May 2018 01:05:18 +0200 Subject: [PATCH 04/11] external links: formatting --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index acd96bfa..49ca88e9 100644 --- a/README.md +++ b/README.md @@ -1391,7 +1391,7 @@ See also [Documentation Generators](#documentation-generators), [Wikimatrix](htt - [Awesome Big Data](https://github.com/onurakpolat/awesome-bigdata) - Curated list of awesome big data frameworks, resources and other awesomeness. - [Awesome Sysadmin](https://github.com/n1trux/awesome-sysadmin) - Curated list of amazingly awesome open source sysadmin resources. -- [PRISM Break](https://prism-break.org/en/), [privacytools.io](https://www.privacytools.io/), [Alternative Internet](https://redecentralize.github.io/alternative-internet/), [Libre Projects](http://libreprojects.net/) - Lists of software aimed at privacy and decentralization (in some form). +- Lists of software aimed at privacy and decentralization in some form: [PRISM Break](https://prism-break.org/en/), [privacytools.io](https://www.privacytools.io/), [Alternative Internet](https://redecentralize.github.io/alternative-internet/), [Libre Projects](http://libreprojects.net/) - Dynamic Domain Name services: [Afraid.org](https://freedns.afraid.org/domain/registry/), [Pagekite](https://pagekite.net/) - Communities/forums: [/r/selfhosted](https://www.reddit.com/r/selfhosted), [IndieWeb](https://indieweb.org/), [Auto-Hébergement (FR)](http://www.auto-hebergement.fr/) From 1c9755bee795e827aab5ce1474e7b3890cad4fe0 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 13 May 2018 01:05:30 +0200 Subject: [PATCH 05/11] external links: remove link to auto-hebergement.fr mostly inactive, last actual wiki revision is from 2016 https://wiki.auto-hebergement.fr/start?do=recent --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 49ca88e9..cfa3158f 100644 --- a/README.md +++ b/README.md @@ -1393,7 +1393,7 @@ See also [Documentation Generators](#documentation-generators), [Wikimatrix](htt - [Awesome Sysadmin](https://github.com/n1trux/awesome-sysadmin) - Curated list of amazingly awesome open source sysadmin resources. - Lists of software aimed at privacy and decentralization in some form: [PRISM Break](https://prism-break.org/en/), [privacytools.io](https://www.privacytools.io/), [Alternative Internet](https://redecentralize.github.io/alternative-internet/), [Libre Projects](http://libreprojects.net/) - Dynamic Domain Name services: [Afraid.org](https://freedns.afraid.org/domain/registry/), [Pagekite](https://pagekite.net/) -- Communities/forums: [/r/selfhosted](https://www.reddit.com/r/selfhosted), [IndieWeb](https://indieweb.org/), [Auto-Hébergement (FR)](http://www.auto-hebergement.fr/) +- Communities/forums: [/r/selfhosted](https://www.reddit.com/r/selfhosted), [IndieWeb](https://indieweb.org/) -------------------- From 9bfe157a7475adfabf2eecc843f8f080c68a52d6 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Wed, 16 May 2018 19:14:37 +0200 Subject: [PATCH 06/11] remove link to rocket.chat instance (certificate expired) --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a13935ca..fb24419d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,6 +1,6 @@ ## Contributing -Please join us on [chat](https://chat.awesh.unknownplus.com/channel/awesome-selfhosted) or open a new issue to clarify any questions. +Please open a new issue to clarify any questions, or post in the [General discussion issue](https://github.com/Kickball/awesome-selfhosted/issues/89). All guidelines for adding new software to the list are listed in [PULL_REQUEST_TEMPLATE.md](PULL_REQUEST_TEMPLATE.md). From 539173921bbae7f01f882b5968d670640c9a1940 Mon Sep 17 00:00:00 2001 From: Edward Dickson Date: Wed, 13 Jun 2018 22:00:54 +0100 Subject: [PATCH 07/11] Grammar Fixes for HomeHost Fix punctuation for HomeHost (multimedia streaming). --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0284558c..3fa95b73 100644 --- a/README.md +++ b/README.md @@ -815,7 +815,7 @@ See also , Date: Wed, 13 Jun 2018 22:06:40 +0100 Subject: [PATCH 08/11] Update Document Archiving Section * Rename Document Archiving section to Document management * Move SANE and CUPS to Misc section --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0284558c..81098a64 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ See [Contributing](.github/CONTRIBUTING.md). - [Content Management Systems (CMS)](#content-management-systems-cms) - [E-commerce](#e-commerce) - [DNS](#dns) -- [Document Archiving](#document-archiving) +- [Document Management](#document-management) - [E-books and Integrated Library Systems (ILS)](#e-books-and-integrated-library-systems-ils) - [Enterprise Resource Planning](#enterprise-resource-planning) - [Federated Identity/Authentication](#federated-identityauthentication) @@ -549,15 +549,13 @@ See https://github.com/n1trux/awesome-sysadmin#dns - [nsupdate.info](https://www.nsupdate.info/) - nsupdate.info is a dynamic DNS service. ([Demo](https://www.nsupdate.info/account/register/), [Source Code](https://github.com/nsupdate-info/nsupdate.info)) `BSD-3-Clause` `Python` - [SPF Toolbox](http://spftoolbox.charlesabarnes.com) - Application to look up DNS records such as SPF, MX, Whois, and more. ([Source Code](https://github.com/bulbajackel/SPFtoolbox)) `MIT` `PHP` -## Document Archiving +## Document Management **[`^ back to top ^`](#)** -- [CUPS](https://www.cups.org/) - The Common Unix Print System uses Internet Printing Protocol (IPP) to support printing to local and network printers. ([Source Code](https://www.cups.org/software.php)) `GPL-2.0` `C` - [EdPaper](https://github.com/Edraens/EdPaper) - PDF organizer with users management. `MIT` `PHP` - [Mayan EDMS](http://www.mayan-edms.com) - Free Open Source Electronic Document Management System. An electronic vault for your documents with preview generation, OCR, and automatic categorization among other features. ([Source Code](https://gitlab.com/mayan-edms/mayan-edms)) `Apache-2.0` `Python` - [Paperless](https://github.com/danielquinn/paperless) - Scan, index, and archive all of your paper documents. `GPL-3.0` `Python` -- [SANE Network Scanning](http://sane-project.org/) - Allow remote clients to access image acquisition devices (scanners) available on the local host. ([Source Code](http://www.sane-project.org/cvs.html)) `GPL-2.0` `C` ## E-books and Integrated Library Systems (ILS) @@ -871,6 +869,7 @@ See also , , Date: Sat, 16 Jun 2018 16:07:30 +0200 Subject: [PATCH 09/11] readme: remove main chat link (certificate expired) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cfa3158f..3f174c51 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Awesome-Selfhosted -[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) [![](https://camo.githubusercontent.com/3d659054abd6ce21c0e47cf3b83a51bda69ca282/68747470733a2f2f64656d6f2e726f636b65742e636861742f696d616765732f6a6f696e2d636861742e737667)](https://chat.awesh.unknownplus.com/channel/awesome-selfhosted) +[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) Selfhosting is the process of locally hosting and managing applications instead of renting from SaaS providers. From 53c93c24c8efa5e5a29bc8148113220c9e1f3390 Mon Sep 17 00:00:00 2001 From: DJCrashdummy Date: Sat, 16 Jun 2018 16:25:35 +0200 Subject: [PATCH 10/11] added source and demo link for myTinyTodo (#1406) * added source-link of myTinyTodo * added demo-link for myTinyTodo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c77f6ef..e32ffe43 100644 --- a/README.md +++ b/README.md @@ -1221,7 +1221,7 @@ See https://staticsitegenerators.net and https://www.staticgen.com - [Crepido](https://github.com/arshad/crepido) - Create (kanban) boards to track users and projects from flat markdown files. `MIT` `Nodejs` - [Kanboard](http://kanboard.net/) - Simple and open source visual task board. ([Source Code](https://github.com/kanboard/kanboard)) `MIT` `PHP` - [Wheatbin](http://wheatbin.com/) - Project management software that combines Kanban methodology with the Law of the Harvest. ([Source Code](https://github.com/wheatbin/wheatbin)) `MIT` `PHP` -- [myTinyTodo](http://www.mytinytodo.net/) - Simple way to manage your todo list in AJAX style. Uses PHP, jQuery, SQLite/MySQL. GTD compliant. `GPL-2.0` `PHP` +- [myTinyTodo](http://www.mytinytodo.net/) - Simple way to manage your todo list in AJAX style. Uses PHP, jQuery, SQLite/MySQL. GTD compliant. ([Demo](http://www.mytinytodo.net/demo/), [Source Code](https://bitbucket.org/maxpozdeev/mytinytodo)) `GPL-2.0` `PHP` - [omgnata](https://github.com/chr15m/omgnata) - Mobile friendly zero-feature TODO list web app. Unix philosophy. ([Demo](https://chr15m.github.io/omgnata/)) `GPL-3.0` `ClojureScript` - [PHP Task/Todo list](https://github.com/lgg/tasks.php) - Simple task/todo list that uses a JSON text file for the tasks. `MIT` `PHP` - [Restyaboard](http://restya.com/board/) - Open source Trello-like kanban board. ([Demo](http://restya.com/board/demo.html), [Source Code](https://github.com/RestyaPlatform/board)) `OSL-3.0` `PHP` From 9d0671b4edb61880efbf61f4f69e2a8d359e9178 Mon Sep 17 00:00:00 2001 From: DJCrashdummy Date: Sat, 16 Jun 2018 16:26:44 +0200 Subject: [PATCH 11/11] added demo link for scrumblr (#1407) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e32ffe43..370c7117 100644 --- a/README.md +++ b/README.md @@ -1225,7 +1225,7 @@ See https://staticsitegenerators.net and https://www.staticgen.com - [omgnata](https://github.com/chr15m/omgnata) - Mobile friendly zero-feature TODO list web app. Unix philosophy. ([Demo](https://chr15m.github.io/omgnata/)) `GPL-3.0` `ClojureScript` - [PHP Task/Todo list](https://github.com/lgg/tasks.php) - Simple task/todo list that uses a JSON text file for the tasks. `MIT` `PHP` - [Restyaboard](http://restya.com/board/) - Open source Trello-like kanban board. ([Demo](http://restya.com/board/demo.html), [Source Code](https://github.com/RestyaPlatform/board)) `OSL-3.0` `PHP` -- [scrumblr](http://scrumblr.ca/) - Collaborative Online Scrum Tool Using Websockets, Node.js, jQuery, and CSS3. ([Source Code](https://github.com/ocdtrekkie/scrumblr/tree/sandstorm)) `GPL-3.0` `Nodejs` +- [scrumblr](http://scrumblr.ca/) - Collaborative Online Scrum Tool Using Websockets, Node.js, jQuery, and CSS3. ([Demo](http://scrumblr.ca/demo), [Source Code](https://github.com/ocdtrekkie/scrumblr/tree/sandstorm)) `GPL-3.0` `Nodejs` - [TaskBoard](http://taskboard.matthewross.me/) - Kanban-inspired app for keeping track of things that need to get done. ([Source Code](https://github.com/kiswa/TaskBoard)) `MIT` `PHP` - [Taskfreak](http://www.taskfreak.com/original) - Simple but efficient web based task manager written in PHP. ([Demo](http://demo.taskfreak.com/)) `GPL-3.0` `PHP` - [Tasks](https://github.com/m1guelpf/tasks) - Simple tasks and notes manager written in PHP, jQuery and Bootstrap using a custom flat file database. `MPL-2.0` `PHP`