{"id":26455050,"url":"https://github.com/jiprettycool/lunatransfer","last_synced_at":"2025-10-11T12:05:49.392Z","repository":{"id":281756384,"uuid":"946319529","full_name":"JIPrettyCool/LunaTransfer","owner":"JIPrettyCool","description":"📂 Self-hostable Managed File Transfer solution built with Go, featuring API keys, comprehensive audit logging, and real-time WebSocket notifications for secure file exchange.","archived":false,"fork":false,"pushed_at":"2025-05-04T07:38:35.000Z","size":365,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-11T12:05:48.818Z","etag":null,"topics":["api","api-key","audit-logging","authentication","file-management","file-sharing","file-transfer","go","golang","jwt","managed-file-transfer","notifications","rate-limiting","rest-api","secure-transfer","security","self-hosted","websockets"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JIPrettyCool.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-11T00:35:42.000Z","updated_at":"2025-05-04T07:38:38.000Z","dependencies_parsed_at":"2025-03-21T19:25:52.017Z","dependency_job_id":"c1201763-8ac1-47af-bcb7-84becd3d396e","html_url":"https://github.com/JIPrettyCool/LunaTransfer","commit_stats":null,"previous_names":["jiprettycool/lunamft","jiprettycool/lunatransfer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/JIPrettyCool/LunaTransfer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JIPrettyCool%2FLunaTransfer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JIPrettyCool%2FLunaTransfer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JIPrettyCool%2FLunaTransfer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JIPrettyCool%2FLunaTransfer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JIPrettyCool","download_url":"https://codeload.github.com/JIPrettyCool/LunaTransfer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JIPrettyCool%2FLunaTransfer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279007135,"owners_count":26084247,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-key","audit-logging","authentication","file-management","file-sharing","file-transfer","go","golang","jwt","managed-file-transfer","notifications","rate-limiting","rest-api","secure-transfer","security","self-hosted","websockets"],"created_at":"2025-03-18T20:29:46.544Z","updated_at":"2025-10-11T12:05:49.356Z","avatar_url":"https://github.com/JIPrettyCool.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# **LunaTransfer**\n\nSelf Hostable Managed File Transfer app\n\n## Configuration\n\nLunaTransfer can be configured by editing the config file before startup. The following settings can be customized:\n\n- Port number\n- Storage path\n- Log directory\n- JWT secret and expiration time\n- Rate limiting settings\n\n## API Usage Examples\n\n### Initial Setup and Authentication\n\n#### Initial Setup (Admin signup)\n\n```bash\ncurl -X POST http://localhost:8080/setup \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"username\": \"admin\",\n    \"password\": \"AdminPassword123!\",\n    \"email\": \"admin@example.com\"\n  }'\n```\n\n#### Signup\n\n```bash\ncurl -X POST http://localhost:8080/signup \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"username\":\"test1\",\"password\":\"Test1Password123\",\"email\":\"test@example.com\",\"role\":\"user\"}'\n```\n\n#### Login (Get JWT Token)\n\n```bash\ncurl -X POST http://localhost:8080/login \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"username\":\"test1\",\"password\":\"Test1Password123\"}'\n```\n\n#### Logout\n\n```bash\ncurl -X POST http://localhost:8080/logout \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n```\n\n#### Refresh Token\n\n```bash\ncurl -X POST http://localhost:8080/api/refresh \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n```\n\n### File Operations\n\n#### Upload File\n\n```bash\ncurl -X POST http://localhost:8080/api/upload \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\" \\\n  -F \"file=@/path/to/your/file.txt\" \\\n  -F \"path=photos/vacation2023\"\n```\n\n#### List Files\n\n```bash\ncurl -X GET \"http://localhost:8080/api/files?path=photos/vacation2023\" \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n```\n\n#### Search Files\n\n```bash\ncurl -X GET \"http://localhost:8080/api/search?term=project\" \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n\n  # Search in specific directory\ncurl -X GET \"http://localhost:8080/api/search?term=report\u0026path=documents\" \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n\n# Search by file type (extension)\ncurl -X GET \"http://localhost:8080/api/search?term=data\u0026type=csv\" \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n\n# Search by file size (in bytes)\ncurl -X GET \"http://localhost:8080/api/search?term=video\u0026minSize=1000000\u0026maxSize=5000000\" \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n\n# Search by date modified\ncurl -X GET \"http://localhost:8080/api/search?term=report\u0026after=2005-08-08\u0026before=2005-08-08\" \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n\n# Combining multiple filters\ncurl -X GET \"http://localhost:8080/api/search?term=presentation\u0026path=work\u0026type=pptx\u0026minSize=500000\" \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n```\n\n#### Download File\n\n```bash\ncurl -X GET http://localhost:8080/api/download/file.txt \\\n  -H \"Authorization: Bearer YOUR_JWT_KEY\" \\\n  --output downloaded_file.txt\n```\n\n### Delete File\n\n```bash\ncurl -X DELETE http://localhost:8080/api/delete/file.txt \\\n  -H \"Authorization: Bearer YOUR_JWT_KEY\"\n```\n\n\n#### Create Directory\n\n```bash\ncurl -X POST http://localhost:8080/api/directory \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"path\":\"photos\", \"name\":\"vacation2023\"}'\n```\n\n### Admin Operations\n\n#### List Users (Admin Only)\n\n```bash\ncurl -X GET http://localhost:8080/api/admin/users \\\n  -H \"Authorization: Bearer ADMIN_JWT_TOKEN\"\n```\n\n#### Delete User (Admin Only)\n\n```bash\ncurl -X DELETE http://localhost:8080/api/admin/users/username \\\n  -H \"Authorization: Bearer ADMIN_JWT_TOKEN\"\n```\n\n#### System Stats (Admin Only)\n\n```bash\ncurl -X GET http://localhost:8080/api/admin/system/stats \\\n  -H \"Authorization: Bearer ADMIN_JWT_TOKEN\"\n```\n\n### Groups\n\n#### Create Group (Admin Only)\n\n```bash\ncurl -X POST http://localhost:8080/api/admin/groups \\\n  -H \"Authorization: Bearer ADMIN_JWT_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"name\": \"Marketing Team\",\n    \"description\": \"Group for marketing department files\"\n  }'\n```\n\n#### List Groups (Admin Only)\n\n```bash\ncurl -X GET http://localhost:8080/api/admin/groups \\\n  -H \"Authorization: Bearer ADMIN_JWT_TOKEN\"\n```\n\n#### Add User to Group (Admin Only)\n\n```bash\ncurl -X POST \"http://localhost:8080/api/admin/groups/YOUR_GROUP_ID/members\" \\\n  -H \"Authorization: Bearer ADMIN_JWT_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"username\": \"user1\",\n    \"role\": \"member\"\n  }'\n```\n\n#### Remove User from Group (Admin Only)\n\n```bash\ncurl -X DELETE \"http://localhost:8080/api/admin/groups/YOUR_GROUP_ID/members/username\" \\\n  -H \"Authorization: Bearer ADMIN_JWT_TOKEN\"\n```\n\n#### List Group Members (Admin Only)\n\n```bash\ncurl -X GET \"http://localhost:8080/api/admin/groups/YOUR_GROUP_ID/members\" \\\n  -H \"Authorization: Bearer ADMIN_JWT_TOKEN\"\n```\n\n#### Upload File to Group Directory (Group Members Only)\n\n```bash\ncurl -X POST http://localhost:8080/api/upload/group \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\" \\\n  -F \"file=@/path/to/your/file.txt\" \\\n  -F \"groupId=YOUR_GROUP_ID\" \\\n  -F \"path=reports/monthly\"\n```\n\n#### Download File from Group Directory (Group Members Only)\n\n```bash\ncurl -X GET http://localhost:8080/api/download/groups/YOUR_GROUP_ID/path/to/file.txt \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\" \\\n  --output downloaded_file.txt\n```\n\n#### List Files in Group Directory (Group Members Only)\n\n```bash\ncurl -X GET \"http://localhost:8080/api/files?path=groups/YOUR_GROUP_ID/reports\" \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n```\n\n#### Add User to Group with Specific Role (Admin Only)\n\n```bash\ncurl -X POST \"http://localhost:8080/api/admin/groups/YOUR_GROUP_ID/members\" \\\n  -H \"Authorization: Bearer ADMIN_JWT_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"username\": \"user1\",\n    \"role\": \"contributor\"\n  }'\n```\n##### Group Role Permissions\n\nLunaTransfer supports three levels of group roles:\n\n- **admin**: Can manage group members and has full access to all group files\n- **contributor**: Can upload, modify, and download files but cannot manage members\n- **reader**: Can only view and download files\n\n#### Share a File with Another Group\n\n```bash\ncurl -X POST http://localhost:8080/api/share \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"file_path\": \"path/to/file.txt\",\n    \"source_group\": \"SOURCE_GROUP_ID\",\n    \"target_group\": \"TARGET_GROUP_ID\",\n    \"permission\": \"read\"\n  }'\n```\n\n#### List Files Shared with a Group\n\n```bash\ncurl -X GET \"http://localhost:8080/api/shared?groupId=YOUR_GROUP_ID\" \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n```\n\n#### Remove File Sharing\n\n```bash\ncurl -X DELETE http://localhost:8080/api/share/SHARE_ID \\\n  -H \"Authorization: Bearer YOUR_JWT_TOKEN\"\n```\n\n### Misc\n\n#### Get User Dashboard\n\n```bash\ncurl -X GET http://localhost:8080/api/dashboard \\\n  -H \"Authorization: Bearer YOUR_JWT_KEY\"\n```\n\n#### WebSocket Connection (for real-time notifications)\n\n```bash\n# Using a WebSocket client like wscat\nwscat -c \"ws://localhost:8080/ws\" -H \"Authorization: Bearer YOUR_JWT_KEY\"\n```\n##### Notification Types\n\n- **CONNECTED:** Sent when a WebSocket connection is established\n- **FILE_UPLOADED:** Sent when a new file is uploaded\n- **FILE_DELETED:** Sent when a file is deleted\n- **SHARE_CREATED:** Sent when a file is shared with a group\n- **SHARE_REMOVED:** Sent when a file share is removed\n\n## TODO\n[View my Notion page](https://jiprettycool.notion.site/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjiprettycool%2Flunatransfer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjiprettycool%2Flunatransfer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjiprettycool%2Flunatransfer/lists"}