Add MIT License and update README
Introduced an MIT license file to the project to clarify the terms under which the software can be used and redistributed. Additionally, the README was enhanced with installation instructions and a usage section for the rake task that purges inactive Zammad customer accounts. The update also includes a disclaimer regarding the use of the task and reaffirms the licensing details.
This commit is contained in:
parent
0fe150afbf
commit
8148b512e0
2 changed files with 45 additions and 1 deletions
19
LICENSE
Normal file
19
LICENSE
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
Copyright (c) 2023 Private.coffee Team <support@private.coffee>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
27
README.md
27
README.md
|
@ -1,3 +1,28 @@
|
||||||
# zammad-purge-inactive-users
|
# zammad-purge-inactive-users
|
||||||
|
|
||||||
A rake task to purge Customer accounts from Zammad if they haven't had any open tickets for 30 days.
|
A rake task to purge Customer accounts from Zammad if they haven't had any open
|
||||||
|
tickets for 30 days.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. Copy the `purge_inactive_users.rake` file to `/opt/zammad/lib/tasks/`
|
||||||
|
|
||||||
|
2. Set up a cron job to run the rake task every day at 1am:
|
||||||
|
|
||||||
|
```
|
||||||
|
0 1 * * * /usr/bin/zammad run rake purge_inactive_users
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
The rake task will run every day at 1am and delete any Customer accounts that haven't
|
||||||
|
had any open tickets for 30 days.
|
||||||
|
|
||||||
|
## Disclaimer
|
||||||
|
|
||||||
|
This rake task is provided as-is and without warranty. Use at your own risk.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This rake task is released under the MIT License. See the bundled LICENSE file
|
||||||
|
for details.
|
||||||
|
|
Loading…
Reference in a new issue