Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anyproto/any-sync-filenode
Implementation of file node from any-sync protocol
https://github.com/anyproto/any-sync-filenode
e2ee p2p privacy
Last synced: about 21 hours ago
JSON representation
Implementation of file node from any-sync protocol
- Host: GitHub
- URL: https://github.com/anyproto/any-sync-filenode
- Owner: anyproto
- License: mit
- Created: 2023-05-23T14:08:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-22T11:23:02.000Z (8 months ago)
- Last Synced: 2024-04-22T12:40:12.958Z (8 months ago)
- Topics: e2ee, p2p, privacy
- Language: Go
- Homepage: https://anytype.io
- Size: 5.79 MB
- Stars: 29
- Watchers: 9
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Any-Sync File Node
Implementation of file node from [`any-sync`](https://github.com/anyproto/any-sync) protocol.
## Building the source
To ensure compatibility, please use Go version `1.22`.
To build and run the Any-Sync File Node on your own server, follow these technical steps:
1. Clone the Any-Sync File Node repository to your local machine.
2. Navigate to the root directory of the repository, where you will find a `Makefile`.
3. Run the following commands to install the required dependencies and build the Any-Sync File Node.
```
make deps
make build
```
4. If there are no errors, the Any-Sync File Node will be built and can be found in the `/bin` directory.
## Running
You will need an S3-compatible object storage and Redis to run Any-Sync File Node. Note that credentials are necessary to make requests to S3. For more information, refer to the [`aws-sdk-go` documentation](https://pkg.go.dev/github.com/aws/aws-sdk-go#readme-configuring-credentials).
Any-Sync File Node requires a configuration. You can generate configuration files for your nodes with [`any-sync-network`](https://github.com/anyproto/any-sync-tools) tool.
The following options are available for running the Any-Sync File Node:
- `-c` — path to config file (default `etc/any-sync-filenode.yml`).
- `-v` — current version.
- `-h` — help message.
## Contribution
Thank you for your desire to develop Anytype together!
❤️ This project and everyone involved in it is governed by the [Code of Conduct](https://github.com/anyproto/.github/blob/main/docs/CODE_OF_CONDUCT.md).
🧑💻 Check out our [contributing guide](https://github.com/anyproto/.github/blob/main/docs/CONTRIBUTING.md) to learn about asking questions, creating issues, or submitting pull requests.
🫢 For security findings, please email [[email protected]](mailto:[email protected]) and refer to our [security guide](https://github.com/anyproto/.github/blob/main/docs/SECURITY.md) for more information.
🤝 Follow us on [Github](https://github.com/anyproto) and join the [Contributors Community](https://github.com/orgs/anyproto/discussions).
---
Made by Any — a Swiss association 🇨🇭
Licensed under [MIT License](./LICENSE).