{"id":28465638,"url":"https://github.com/yangziwen/zy-ftp","last_synced_at":"2025-06-30T20:32:25.078Z","repository":{"id":37095314,"uuid":"142318068","full_name":"yangziwen/zy-ftp","owner":"yangziwen","description":"A netty based ftp server","archived":false,"fork":false,"pushed_at":"2025-06-06T13:36:08.000Z","size":248,"stargazers_count":9,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-07T06:01:48.741Z","etag":null,"topics":["ftp","netty","server"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yangziwen.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}},"created_at":"2018-07-25T15:18:49.000Z","updated_at":"2025-06-06T13:36:10.000Z","dependencies_parsed_at":"2025-06-06T20:47:45.959Z","dependency_job_id":null,"html_url":"https://github.com/yangziwen/zy-ftp","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/yangziwen/zy-ftp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yangziwen%2Fzy-ftp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yangziwen%2Fzy-ftp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yangziwen%2Fzy-ftp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yangziwen%2Fzy-ftp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yangziwen","download_url":"https://codeload.github.com/yangziwen/zy-ftp/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yangziwen%2Fzy-ftp/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262846325,"owners_count":23373803,"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","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":["ftp","netty","server"],"created_at":"2025-06-07T06:00:41.297Z","updated_at":"2025-06-30T20:32:25.023Z","avatar_url":"https://github.com/yangziwen.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"## zy-ftp\n\n[![Java CI with Maven](https://github.com/yangziwen/zy-ftp/actions/workflows/maven.yml/badge.svg)](https://github.com/yangziwen/zy-ftp/actions/workflows/maven.yml)\n\n[Chinese Doc](https://github.com/yangziwen/zy-ftp/blob/master/README_CN.md)\n### Introduction\nA netty based ftp server\n\n### Feature\n* Implements most frequently used ftp commands ([see details](https://github.com/yangziwen/zy-ftp/tree/master/src/main/java/io/github/yangziwen/zyftp/command/impl))\n* Support configurations of user access priviledge and file transfer rate limit ([see options](https://github.com/yangziwen/zy-ftp/blob/master/conf/server.config))\n* Both active mode and passive mode are supported under cleartext transmission\n* Only passive mode is supported when transfer data over TLS\n* Only passive mode is supported when running inside a docker container\n\n### Usage\n* Running an embedded server\n    1. Import the dependency\n    ```xml\n    \u003cdependency\u003e\n        \u003cgroupId\u003eio.github.yangziwen\u003c/groupId\u003e\n        \u003cartifactId\u003ezy-ftp\u003c/artifactId\u003e\n        \u003cversion\u003e0.0.2\u003c/version\u003e\n    \u003c/dependency\u003e\n    ```\n    2. Start the server\n    ```java\n    FtpRunner runner = FtpRunner.builder()\n        .localIp(\"127.0.0.1\")\n        .localPort(8121)\n        .configFile(new File(\"conf/server.config\"))\n        .logFile(new File(\"log/zy-ftp.log\"))\n        .build();\n\n    runner.run();\n    ```\n* Running the JAR file standalone\n    1. Build the JAR file ：`mvn package -Pstandalone` or `sh gradlew build`\n    2. Start the server：`java -jar zy-ftp.jar -c ${config_file_path}`\n* Running inside a docker container\n    1. Build the docker image：`mvn package dockerfile:build -Pstandalone` or `sh gradlew dockerBuild`\n    2. Start the container：\n    ```\n    docker run -d \\\n      -v ${your_config_file}:/zy-ftp/server.config \\\n      -v ${your_resource_folder}:/zy-ftp/res \\\n      -e LOCAL_PORT=8121 \\\n      -p 8121:8121 \\\n      -e PASSIVE_PORTS=40000-40060 \\\n      -p 40000-40060:40000-40060 \\\n      zy-ftp:0.0.2\n    ```\n* See more options：`java -jar zy-ftp.jar -h`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyangziwen%2Fzy-ftp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyangziwen%2Fzy-ftp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyangziwen%2Fzy-ftp/lists"}