-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Any-Sync File Node | ||
Implementation of file node from [`any-sync`](https://github.com/anyproto/any-sync) protocol. | ||
|
||
## Building the source | ||
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 command `make deps` to install the required dependencies for the Any-Sync File Node.* | ||
4. Run the command `make build` to build the Any-Sync File Node.* | ||
5. If there are no errors, the Any-Sync File Node will be built and can be found in the `/bin` directory. | ||
|
||
*To avoid any Go language version incompatibility issues, please use version `1.19` of Go. | ||
|
||
## Running | ||
When running the Any-Sync File Node, you can use the following options: | ||
|
||
- `-c` Every node should be run with the configuration file option. By | ||
default, the option flag is set to `etc/any-sync-node.yml.` You can | ||
always generate a new configuration using the appropriate command **???** | ||
- `-v` This option shows the current version of the Any-Sync Node and then exits. | ||
- `-h` This option shows the help message and then exits. | ||
|
||
## Contribution | ||
Thank you for your desire to develop Anytype together. | ||
|
||
Currently, we're not ready to accept PRs, but we will in the nearest future. | ||
|
||
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). |