https://github.com/standardnotes/syncing-server
[Deprecated: Use our new Node server: https://github.com/standardnotes/syncing-server-js]
https://github.com/standardnotes/syncing-server
Last synced: 10 months ago
JSON representation
[Deprecated: Use our new Node server: https://github.com/standardnotes/syncing-server-js]
- Host: GitHub
- URL: https://github.com/standardnotes/syncing-server
- Owner: standardnotes
- License: agpl-3.0
- Archived: true
- Created: 2019-12-04T22:06:10.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-20T13:51:08.000Z (over 4 years ago)
- Last Synced: 2024-08-02T16:05:01.989Z (over 1 year ago)
- Language: Ruby
- Homepage: https://standardnotes.org
- Size: 828 KB
- Stars: 209
- Watchers: 15
- Forks: 48
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ⛔️ Deprecation Notice
This codebase is deprecated in favor of our [new Node.js server](https://github.com/standardnotes/syncing-server-js). For self-hosting, use [standardnotes/standalone](https://github.com/standardnotes/standalone).
## Standard Notes Syncing Server
You can run your own Standard Notes server and use it with any Standard Notes app. This allows you to have 100% control of your data. This server is built with Ruby on Rails and can be deployed in minutes.
**Requirements**
- Docker
**Data persistency**
Your MySQL Data will be written to your local disk in the `data` folder to keep it persistent between server runs.
### Getting started
1. Clone the project:
```
git clone --branch master https://github.com/standardnotes/syncing-server.git
```
1. Setup the server by running:
```
./server.sh setup
```
1. Run the server by typing:
```
./server.sh start
```
Your server should now be available under http://localhost:3000
### Logs
You can check the logs of the running server by typing:
```
./server.sh logs
```
### Stopping the Server
In order to stop the server type:
```
./server.sh stop
```
### Updating to latest version
In order to update to the latest version of our software please first stop the server and then type:
```
./server.sh update
```
### Checking Status
You can check the status of running services by typing:
```
./server.sh status
```
### Cleanup Data
Please use this step with caution. In order to remove all your data and start with a fresh environment please type:
```
./server.sh cleanup
```
### Tests
The `syncing-server` uses [RSpec](http://rspec.info) for tests.
To execute all of the test specs, run the following command at the root of the project directory:
```bash
bundle exec rspec
```
Code coverage report is available within the `coverage` directory.