NodeDB is a simple local file-based database system implemented in Node.js. It allows you to store, retrieve, update, and delete data using various file formats (text, JSON, YAML) as the backend storage. The system includes advanced authentication using JWT and supports multiple database styles, including an encrypted variant.
- JWT Authentication: Secure your data with JSON Web Token (JWT) authentication for all operations.
- Multiple Database Styles: Supports text, JSON, YAML, and encrypted database formats.
- CRUD Operations: Perform Create, Read, Update, and Delete operations on your data.
- Rate Limiting: Limits the number of requests from an IP to prevent abuse.
- CORS Support: Allows cross-origin requests for easier integration with front-end applications.
- Input Validation: Ensures that the data being sent to the server is in the correct format.
- Customizable Configuration: Easily configure the server, authentication, and database settings.
Before you begin, ensure you have met the following requirements:
- Node.js: (v14.x or higher)
- npm: (v6.x or higher)
-
Clone the repository:
git clone https://github.com/CanaryGen/NodeDB.git cd NodeDB -
Install dependencies:
npm install express js-yaml body-parser bcrypt winston express-rate-limit cors joi jsonwebtoken crypto
This file contains server configuration settings such as the port number, JWT settings, and rate limiting.
Example:
port: 3000
ip: 0.0.0.0
JWT:
useJWT: true
secret: "your_secret_key"
databaseStyle: "nodedb" # Possible values: nodedb, json, yml, sec_nodedb
encryptionKey: "your_encryption_key" # Only required if databaseStyle is sec_nodedb
rateLimit:
windowMs: 15 * 60 * 1000 # 15 minutes
max: 100 # Limit each IP to 100 requests per windowMsThis file contains user authentication data. Each user has a username and a hashed password.
Example:
users:
- username: admin
password: $2b$10$GZk7n/b5QqKJZ9Z5z5z5zODepending on the databaseStyle setting in config.yml, the data will be stored in different formats:
- nodedb:
db/database.txt - json:
db/database.json - yml:
db/database.yml - sec_nodedb:
db/sec_database.txt(encrypted)
To start the server, run the following command:
node server.jsTo authenticate, include the Authorization header with your requests. The header value should be in the format Bearer <JWT-token> if JWT is enabled, or Basic <base64-encoded-credentials> if JWT is disabled.
-
POST /login: Authenticate with the server and get a JWT token.
curl -X POST http://localhost:3000/login -H "Content-Type: application/json" -d "{\"username\": \"admin\", \"password\": \"adminpassword\"}"
-
GET /data/:key: Retrieve values for a specific key.
curl http://localhost:3000/data/key1 -H "Authorization: Bearer <JWT-token>" -
GET /data/:key/:value: Check if a specific value exists for a key.
curl http://localhost:3000/data/key1/value1 -H "Authorization: Bearer <JWT-token>" -
POST /data: Add a new key and values.
curl -X POST http://localhost:3000/data -H "Content-Type: application/json" -H "Authorization: Bearer <JWT-token>" -d "{\"key\": \"key4\", \"values\": [\"value1\", \"value2\", \"value3\"]}"
-
PUT /data/:key: Update values for an existing key.
curl -X PUT http://localhost:3000/data/key1 -H "Content-Type: application/json" -H "Authorization: Bearer <JWT-token>" -d "{\"values\": [\"newValue1\", \"newValue2\"]}"
-
DELETE /data/:key: Delete a key and its values.
curl -X DELETE http://localhost:3000/data/key1 -H "Authorization: Bearer <JWT-token>"
-
POST /data: Add a new key and values.
curl -X POST http://localhost:3000/data -H "Content-Type: application/json" -H "Authorization: Basic YWRtaW46YWRtaW5wYXNzd29yZA==" -d "{\"key\": \"key4\", \"values\": [\"value1\", \"value2\", \"value3\"]}"
-
GET /data/:key: Retrieve values for a specific key.
curl http://localhost:3000/data/key1 -H "Authorization: Basic YWRtaW46YWRtaW5wYXNzd29yZA==" -
GET /data/:key/:value: Check if a specific value exists for a key.
curl http://localhost:3000/data/key1/value1 -H "Authorization: Basic YWRtaW46YWRtaW5wYXNzd29yZA==" -
PUT /data/:key: Update values for an existing key.
curl -X PUT http://localhost:3000/data/key1 -H "Content-Type: application/json" -H "Authorization: Basic YWRtaW46YWRtaW5wYXNzd29yZA==" -d "{\"values\": [\"newValue1\", \"newValue2\"]}"
-
DELETE /data/:key: Delete a key and its values.
curl -X DELETE http://localhost:3000/data/key1 -H "Authorization: Basic YWRtaW46YWRtaW5wYXNzd29yZA=="
- nodedb: Plain text file with key-value pairs.
- json: JSON file with key-value pairs.
- yml: YAML file with key-value pairs.
- sec_nodedb: Encrypted plain text file with key-value pairs.
curl -X POST http://localhost:3000/data -H "Content-Type: application/json" -H "Authorization: Bearer <JWT-token>" -d "{\"key\": \"key4\", \"values\": [\"value1\", \"value2\", \"value3\"]}"curl -X POST http://localhost:3000/data -H "Content-Type: application/json" -H "Authorization: Basic YWRtaW46YWRtaW5wYXNzd29yZA==" -d "{\"key\": \"key4\", \"values\": [\"value1\", \"value2\", \"value3\"]}"curl http://localhost:3000/data/key1 -H "Authorization: Bearer <JWT-token>"curl http://localhost:3000/data/key1 -H "Authorization: Basic YWRtaW46YWRtaW5wYXNzd29yZA=="curl -X PUT http://localhost:3000/data/key1 -H "Content-Type: application/json" -H "Authorization: Bearer <JWT-token>" -d "{\"values\": [\"newValue1\", \"newValue2\"]}"curl -X PUT http://localhost:3000/data/key1 -H "Content-Type: application/json" -H "Authorization: Basic YWRtaW46YWRtaW5wYXNzd29yZA==" -d "{\"values\": [\"newValue1\", \"newValue2\"]}"curl -X DELETE http://localhost:3000/data/key1 -H "Authorization: Bearer <JWT-token>"curl -X DELETE http://localhost:3000/data/key1 -H "Authorization: Basic YWRtaW46YWRtaW5wYXNzd29yZA=="If you encounter any issues, please check the following:
- Ensure that the server is running.
- Verify that the
Authorizationheader is correctly formatted. - Check the configuration files for any misconfigurations.
If the problem persists, feel free to open an issue on the GitHub repository.