Skip to content

Fixed README with installation instructions for Docker and fixed MySQL errors due to SQLite default #997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 0 commits into from

Conversation

pUrGe12
Copy link
Contributor

@pUrGe12 pUrGe12 commented Feb 2, 2025

Proposed change

  1. The issue with the current documentation is that it is not giving a complete explanation for how to install nettacker properly and run it. I have updated the README with the following changes:
  • Code install docker-compose and docker (the user might face trouble with this if doing this for the first time, like I was)
  • Changed the container name from nettacker-nettacker-1 to nettacker in the second command.
    This was because when I tried running it locally on a new machine, I got the following error:
    Error response from daemon: No such container: nettacker-nettacker-1
    Hence, the change.
  1. Fixed MySQL errors fixing MySQL connections fail due to SQLite specific config in DbConfig #999 and MySQL not working #555

  2. Corrected MySQL server name using pymysql.

  3. Updated docstring for DbConfig class for MySQL related parameters

  4. Corrected db.py file to include pymysql, change arguments based on engine name and improved remove_old_logs function with pymysql required changes.

Type of change

  • New core framework functionality
  • Bugfix (non-breaking change which fixes an issue)
  • Code refactoring without any functionality changes
  • New or existing module/payload change
  • Localization improvement
  • Dependency upgrade
  • Documentation improvement

Checklist

  • I've followed the [contributing guidelines][contributing-guidelines]
  • I've run make pre-commit, it didn't generate any changes
  • I've run make test, all tests passed locally

Additional comments:

  1. The user needs to install pymysql using pip install pymysql
  2. The user needs to ensure their server can handle multiple requests, they can do that using SET GLOBAL max_connections = 1000;
    [contributing-guidelines]: https://nettacker.readthedocs.io/en/latest/Developers/

@pUrGe12 pUrGe12 changed the title Fixed README with proper installation instructions and the installation guide for Docker Fixed README with installation instructions for Docker and fixed MySQL errors due to SQLite default Feb 5, 2025
@pUrGe12 pUrGe12 closed this Feb 5, 2025
@securestep9
Copy link
Collaborator

Hi @pUrGe12 Re: README changes - these are coming with a bigger documentation updates we are working on including re-vamped Dockerfile. Re: mySQL issues - it appears a misconfiguration and we are working on improving the documentation to make it clearer as well

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants