Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
FROM node:6.2.2

COPY . /node
RUN cd /node && npm install -g astrum

RUN mkdir /app
WORKDIR /app

ENTRYPOINT ["/usr/local/lib/node_modules/astrum/manager/astrum.js"]
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ You also have the option to add pages of content, for example an introduction pa
- [Deleting Components](#deleting-components)
- [Deleting Groups](#deleting-groups)
- [Updating Astrum](#updating-astrum)
- [Docker](#docker)
- [Contributing](#contributing)
- [Browser Support](#browser-support)
- [Acknowledgements](#acknowledgements)
Expand Down Expand Up @@ -437,6 +438,32 @@ You will receive feedback that the update is complete.

There is also a `--force` option that you can use to force an update in the event that your Astrum instance is already on the current version. This is if you need to restore your Astrum instance core files.

<a href=“#docker”></a>

To build the docker image:

`docker build -t you/astrum .`

Then to use it:

`docker run -it --rm -v /path-to-your-application:/app you/astrum init ./public/pattern-library`

*Hint* You can always set an alias to make it more compact:

`alias astrum="docker run -it --rm -v $PWD:/app test/astrum"`

As you can see, you don't need to specify the `astrum` binary, as is configured
to be the entrypoint of docker container.

It is important to mount the local volumes to `/app` as is the base working dir.

You can use Docker also to run the generated applications, using a webserver
like nginx:

`docker run -d -v /path-to-your-application/public/pattern-library:/usr/share/nginx/html:ro -p 8080:80 nginx:latest`

Then you can access it on: `http://localhost:8080`

<a href=“#contributing”></a>
## Contributing
Astrum was created by Ryan Taylor & Matt West of [No Divide](http://nodividestudio.com). We welcome anyone and everyone to contribute to the project and help us make Astrum as versatile as possible. If you decide to get involved, please take a moment to review our [contribution guidelines](.github/CONTRIBUTING.md):
Expand Down