https://github.com/zenhack/etherpad-lite-sandstorm
https://github.com/zenhack/etherpad-lite-sandstorm
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zenhack/etherpad-lite-sandstorm
- Owner: zenhack
- License: apache-2.0
- Created: 2021-03-14T16:38:10.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-22T18:02:27.000Z (about 2 years ago)
- Last Synced: 2025-02-03T13:45:07.421Z (4 months ago)
- Language: Shell
- Size: 885 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Status
* See the [changelog](.sandstorm/CHANGELOG.md).
* See the [List of WIP issues](ISSUES.md) (hopefully to move to Github issues at some point)
# Vagrant-spk packaging:
There's a specific hack to get this to work for `vagrant-spk` that's significant enough to mention here. There is a problem installing with npm into a "synced folder". The workaround involves using a bind mount. See the long comment about this in [`.sandstorm/build.sh`](.sandstorm/build.sh).
# Raw packaging:
**WARNING: Don't do this on your normal computer**. This package was designed to work with both `spk` (raw) packaging and `vagrant-spk` packaging. As such, the raw packaging version involves installing things, maybe changing important things on your system, etc. No promises here about what it won't do. This is intended for people who prefer raw spk because they run QubesOS or something like that, where on the one hand VirtualBox is difficult to run, but on the other hand you can make throwaway VMs in which to safely do raw packaging. Most people likely should use the `vagrant-spk` option.
## Setup
1) this repo needs to be checked out at /opt/app. Not as a symlink or anything like that, the real path has to be there. It affects how the app behaves at least in some ways.
2) your user should have write access (without requiring sudo) to /var/.
3) make sure your user isn't for some reason called "vagrant". A couple commands are vagrant-specific, and you may not want those commands to be run here.
## Building
* `sudo .sandstorm/setup.sh`
* `.sandstorm/build.sh`
## Run within Sandstorm
```
cd .sandstorm
spk dev
```
## Run outside of Sandstorm
This could be useful in some cases for debugging and development. If we ever start saving the minified cache as part of the app, this may even become necessary.
* `.sandstorm/launcher.sh`
# License
[Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html) for Etherpad
[Creative Commons Attribution-Sharealike 3.0](https://creativecommons.org/licenses/by-sa/3.0/) for the Etherpad logo (by Marcel Klehr) used for the app icon
## Attributions
Many of the Sandstorm-specific edits have been taken from Kenton's previous versions of:
* [Etherpad Lite Sandstorm App](https://github.com/kentonv/etherpad-lite).
* [`ep_author_neat`](https://github.com/kentonv/ep_author_neat).
* [`ep_comments_page`](https://github.com/kentonv/ep_comments).