diff --git a/docs/database_setup.md b/docs/database_setup.md index e3dac0d..8b3f149 100644 --- a/docs/database_setup.md +++ b/docs/database_setup.md @@ -68,9 +68,9 @@ ports: ```json { "dj_local_conf": { - "database.host": "database_ip", - "database.user": "root", - "database.password": "your_password", + "database.host": "YOUR_DATABASE", + "database.user": "ROOT", + "database.password": "YOUR_PASSWORD", "database.port": 3306 } } diff --git a/docs/getting_started.md b/docs/getting_started.md index 080101b..b4c4983 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -114,7 +114,7 @@ This command adds your user to the docker group, so you can run Docker commands { "dj_local_conf": { "database.host": "127.0.0.1", - "database.user": "root", + "database.user": "ROOT", "database.password": ..., "database.port": 3306 }, @@ -184,6 +184,6 @@ Now that you have a basic understanding of EthoPy: 3. Explore the [Plugin System](plugin.md) to extend functionality 4. Dive deeper into [Local Configuration](local_conf.md) for advanced settings 5. Understand [setup configuration index](setup_configuration_idx.md) -6. Learn more about [Database Setup](database.md) +6. Learn more about [Database Setup](database_setup.md) 7. Study the [API Reference](API/logger.md) for detailed documentation 8. Check [Contributing](contributing.md) if you want to help improve EthoPy \ No newline at end of file diff --git a/docs/local_conf.md b/docs/local_conf.md index dd39085..7f8854d 100644 --- a/docs/local_conf.md +++ b/docs/local_conf.md @@ -18,8 +18,8 @@ When you first start EthoPy, you'll need to create a configuration file. Here's { "dj_local_conf": { "database.host": "127.0.0.1", - "database.user": "root", - "database.password": "your_password_here", + "database.user": "ROOT", + "database.password": "YOUR_PASSWORD_HERE", "database.port": 3306 }, "source_path": "/path/to/your/data", @@ -62,7 +62,7 @@ Here's what a full configuration file looks like with all the optional settings: "Signal": {"PORT1": "GPIO_pin", "PORT2": "GPIO"}, }, "source_path": "LOCAL_RECORDINGS_DIRECTORY", - "target_path": "TARGET_RECORDINGS_DIRECTORY", + "target_path": "TARGET_RECORDINGS_DIRECTORY" } ``` @@ -76,15 +76,15 @@ This section instructs EthoPy to connect to your MySQL database. Below we analyz { "dj_local_conf": { "database.host": "127.0.0.1", // Database server address (127.0.0.1 means your computer) - "database.user": "root", // Your database username - "database.password": "password", // Your database password + "database.user": "ROOT", // Your database username + "database.password": "PASSWORD", // Your database password "database.port": 3306 // Database port number (3306 is standard for MySQL) } } ``` **What you need to change:** -- Replace `"password"` with your actual MySQL password +- Replace `"PASSWORD"` with your actual MySQL password - If your database is on another computer, change `"127.0.0.1"` to that computer's address ### 2. File Paths @@ -196,8 +196,8 @@ You have MySQL running on your computer and want to store data locally: { "dj_local_conf": { "database.host": "127.0.0.1", - "database.user": "root", - "database.password": "your_mysql_password", + "database.user": "ROOT", + "database.password": "YOUR_MYSQL_PASSWORD", "database.port": 3306 }, "source_path": "/Users/yourname/experiment_data", @@ -211,9 +211,9 @@ Your database is on a different computer in the lab: ```json { "dj_local_conf": { - "database.host": "database_ip", // Database server address (make sure your db has fix ip) - "database.user": "lab_user", - "database.password": "lab_password", + "database.host": "YOUR DATABASE", // Database server address (make sure your db has fix ip) + "database.user": "LAB_USER", + "database.password": "LAB_PASSWORD", "database.port": 3306 }, "source_path": "/Users/yourname/experiment_data", @@ -228,8 +228,8 @@ You're running behavioral experiments with physical hardware: { "dj_local_conf": { "database.host": "127.0.0.1", - "database.user": "root", - "database.password": "your_password", + "database.user": "ROOT", + "database.password": "YOUR_PASSWORD", "database.port": 3306 }, "source_path": "/home/pi/experiment_data", diff --git a/docs/nwb_docs.md b/docs/nwb_docs.md index e97cdc8..56ba624 100644 --- a/docs/nwb_docs.md +++ b/docs/nwb_docs.md @@ -150,9 +150,9 @@ The configuration file is a JSON file that specifies how to connect to your Data ```json { "dj_local_conf": { - "database.host": "localhost", - "database.user": "myuser", - "database.password": "mypassword", + "database.host": "LOCALHOST", + "database.user": "MYUSER", + "database.password": "MYPASSWORD", "database.port": 3306, "database.reconnect": true, "database.use_tls": false, diff --git a/docs/raspberry_pi.md b/docs/raspberry_pi.md index 495bb25..ad85dfb 100644 --- a/docs/raspberry_pi.md +++ b/docs/raspberry_pi.md @@ -24,7 +24,7 @@ sudo systemctl start ssh # Starts SSH service immediately "database.host": "YOUR DATABASE", "database.user": "USERNAME", "database.password": "PASSWORD", - "database.port": "PORT", + "database.port": 3306, "database.reconnect": true, "database.enable_python_native_blobs": true }, diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index d1f7880..f30278b 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -47,8 +47,8 @@ This guide addresses common issues you might encounter when using EthoPy and pro { "dj_local_conf": { "database.host": "127.0.0.1", - "database.user": "your_username", - "database.password": "your_password", + "database.user": "YOUR_USERNAME", + "database.password": "YOUR_PASSWORD", "database.port": 3306, "database.reconnect": true, "database.use_tls": false,