diff --git a/.github/workflows/publish-server.yml b/.github/workflows/publish-server.yml new file mode 100644 index 0000000..e3213d5 --- /dev/null +++ b/.github/workflows/publish-server.yml @@ -0,0 +1,28 @@ +name: Publish server + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v3 + with: + node-version: 20 + - name: Build + run: |- + cd server + npm install + npm run compile + - name: Publish + uses: JS-DevTools/npm-publish@v1 + with: + token: ${{ secrets.NPM_TOKEN }} + package: ./server/package.json diff --git a/README.md b/README.md index bfbe1e9..dfbf259 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ -# NUCLIA Sync +# Nuclia Sync agent +The Nuclia Sync Agent is a small application that runs on your computer and keeps your files in sync with the Nuclia cloud. It is available for Windows, macOS, and Linux. + +## Installation + +To install the Nuclia Sync Agent, download the installer from its [repository](https://github.com/nuclia/sync-agent/releases) and run it. + +It runs on port 8090. + +## Configuration + +In the Upload page of the Nuclia dashboard, you can enable the Nuclia Sync Agent and configure it to connect to your computer. +You must use `http://localhost:8090` as the server URL. + +## Deloyment on a server + +If you want to deploy the Nuclia Sync Agent on a server rather than on your computer, you can use the [Nuclia Sync Agent server](https://github.com/nuclia/sync-agent/tree/main/server/README.md). diff --git a/server/README.md b/server/README.md new file mode 100644 index 0000000..5358955 --- /dev/null +++ b/server/README.md @@ -0,0 +1,12 @@ +# Nuclia Sync Agent server + +The Nuclia Sync Agent server is NodeJS application that runs on your server and keeps your files in sync with the Nuclia cloud. + +## Usage + +To install and run the Nuclia Sync Agent server, run the following commands: + +```bash +npm install -g nuclia-sync-agent-server +nuclia-sync-agent-server +``` diff --git a/server/package.json b/server/package.json index c9ff8cc..ca5759b 100644 --- a/server/package.json +++ b/server/package.json @@ -1,6 +1,6 @@ { "name": "@nuclia/sync-agent", - "version": "0.0.1", + "version": "1.0.1", "description": "This is a sync agent to synchronize user files from diferent sources to nuclia", "main": "build/index.js", "types": "build/types/index.d.ts", @@ -11,6 +11,9 @@ "Nuclia" ], "license": "MIT", + "bin": { + "nuclia-sync-agent": "build/start-file-system-server.js" + }, "scripts": { "compile": "tsc", "lint": "eslint .",