Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spacewiki/spacewiki
https://github.com/spacewiki/spacewiki
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/spacewiki/spacewiki
- Owner: spacewiki
- License: agpl-3.0
- Created: 2015-04-01T02:22:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-17T02:47:52.000Z (over 7 years ago)
- Last Synced: 2024-08-01T12:18:25.988Z (3 months ago)
- Language: CSS
- Size: 6.17 MB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
- awesome-starred - spacewiki/spacewiki - (others)
README
# SpaceWiki
[](https://travis-ci.org/tdfischer/spacewiki)
All wiki software sucks. SpaceWiki sucks less than most.
I've been involved with building hackerspaces for the last ~5 years or so. Every
space has a wiki and more often than not it is MediaWiki.
For the longest time, I've wanted some sort of wiki that is tailored
specifically towards low-maintenence installs where nobody should rely on a
swarm of volunteers to curate, maintain, and otherwise write content. Wikipedia
has that and it works fantastic for them. Noisebridge does not and the wiki
tends to turn into a mess of outdated pages, broken images, and the like.
Entropy kills.
Chances are, you'll be looking for the hosted version of SpaceWiki. This can be
found at https://spacewiki.io/, and is free to try.
## Features
SpaceWiki has an exceptionally tiny feature set which should make it easy for
others to get up and going with minimal setup:
* Default sqlite database out of the box
* Markdown page syntax
* The familiar MediaWiki syntax for linking to other pages
* Softlinks for easy-peasy organic discovery of related pages. If you are
unfamiliar with Softlinks, [check out how Everything2 does
it](http://everything2.com/title/Soft+link)
## Run on Heroku!
$ heroku apps:create
$ heroku git:remote
$ git push heroku
$ heroku ps:scale web=1
To import the included documentation, also run:
$ heroku run ./manage.py import_docs
Unfortunately, this app currently uses git submodules which are not supported by the
Heroku button.
## Docker Installation
spacewiki is distributed as a Docker container. To use:
$ docker run -v /srv/spacewiki:/data -p 5000:5000 tdfischer/spacewiki
The Docker container starts ./manage.py runserver, which defaults to serving
spacewiki on 0.0.0.0:5000. The app is installed in /spacewiki/, and all
persistent data/configuration is in /data.
## wsgi Notes
The recommended way to run spacewiki is with Docker, but there is nothing
stopping you from running it on your own. Spacewiki uses flask + peewee and aims
to keep a minimal set of dependencies. The UI uses Foundation and requires
building with sass + uglifyjs + gifsicle + pngcrush.
### Setup
$ make
$ ./manage.py runserver
### Dependencies
$ pip install -r requirements.txt # Python dependencies
$ npm install -g requirejs # Needed for Flask-webassets
For postgres support, also run
$ pip install psycopg2
## Configuration
* ``SECRET_SESSION_KEY`` - Used to generate session cookies for authentication.
## TODO
* Support more than sqlite
* Image uploads
* Crazy easy "attach photo" button for use with a mobile device/camera
## License
SpaceWiki is released under the terms of the GNU Affero General Public License v3
