diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3fe7c909..fb24419d 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 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). + +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 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: diff --git a/README.md b/README.md index 38209cc1..61806f71 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. @@ -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) @@ -552,16 +552,14 @@ 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` -- [Sismics Docs](https://www.sismicsdocs.com/) - Lightweight document management system packed with all the features you can expect from big expensive solutions. ([Demo](https://www.sismicsdocs.com/#!/demo), [Source Code](https://github.com/sismics/docs)) `GPL-2.0` `Java` + ## E-books and Integrated Library Systems (ILS) @@ -823,7 +821,7 @@ See also , , ,