pa/db_archive
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme/license fix

Browse Source
This commit is contained in:
Nicholas R Magarett 2024-07-18 17:49:05 -07:00
parent abdd8e5530
commit 0af55e3922
2 changed files with 66 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
LICENSE.md
View File

@ -1,10 +1,21 @@
### Explanation
MIT License
1. **Features**: Describes the main functionalities of the project.
2. **Configuration**: Explains the configuration variables in both `process.sh` and `upload_handler.php`.
3. **Usage**: Provides step-by-step instructions on how to set up and use the scripts.
4. **Security**: Offers tips on keeping the project secure.
5. **Contributing**: Encourages contributions from the community.
6. **License**: Mentions the licensing information.
Copyright (c) [year] [fullname]
This README should help users understand how to set up and use your project effectively. Adjust the paths and other configuration details according to your specific setup.
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.

47
README.md
View File

@ -55,3 +55,50 @@ CREATE TABLE `archive_logs` (
`protected` tinyint(1) NOT NULL DEFAULT '0',
PRIMARY KEY (`id`)
);
### Usage
1. **Download and Configure Scripts**
- Clone the repository.
- Update the configuration variables in `process.sh`.
- Update the configuration variables in `upload_handler.php` and `config.php`.
2. **Run the Process Script**
Ensure `process.sh` is executable and run it manually or set up a cron job to run it automatically.
chmod +x process.sh
./process.sh
3. **Set Up the Web Server**
- Place `upload_handler.php` and `config.php` on your web server.
- Ensure the `uploadDir` directory is writable by the web server.
- Ensure your web server is configured to handle file uploads.
4. **Database Cleanup**
The `upload_handler.php` script will automatically clean up old, unprotected archives older than 30 days. Protected archives (weekly and version changes) will be retained.
### Security
- Ensure the `UPLOAD_KEY` is kept secret and not exposed in public repositories.
- Use HTTPS to encrypt data transferred between the process script and the web server.
### Contributing
Feel free to submit issues or pull requests if you have suggestions for improvements or bug fixes.
### License
This project is licensed under the MIT License. See the LICENSE file for details.
### Explanation
1. **Features**: Describes the main functionalities of the project.
2. **Configuration**: Explains the configuration variables in both `process.sh` and `upload_handler.php`.
3. **Usage**: Provides step-by-step instructions on how to set up and use the scripts.
4. **Security**: Offers tips on keeping the project secure.
5. **Contributing**: Encourages contributions from the community.
6. **License**: Mentions the licensing information.