docker_manager/README.md

1.8 KiB

Docker Manager

This plugin works with the Discourse docker image. It allows you to perform upgrades via the web UI and monitor activity in the container.

Development Notes

  • Install node.js and yarn
  • Clone this repo to desired folder path
  • In console, from folder path do cd manager-client, yarn install
  • Create a symlink for this folder in your local Discourse instance "plugins" folder (eg. path/to/your/discourse_folder/plugins/discourse_manager)
  • Make sure your Discourse instance is running locally at port 3000 and you are logged in as Admin

The Client App

  • Install the client app dependencies:
    • cd manager-client
    • yarn install
  • Make sure your local Discourse instance is running at port 3000
  • Run ./dev_server which will run ember server for you with proxy to your local Discourse instance
    • If that gives errors, you may need to start your Discourse rails server like this: bundle exec rails s -b 127.0.0.1
  • JUST open up a browser to port 4200 and you're off to the races!

The client application is built using Ember CLI.

To create a compiled version for distribution, run ./compile_client.sh to compile the site and move it into the proper directories.

Running tests

  • Ruby

    • Run RAILS_ENV=test bundle exec rake plugin:spec[docker_manager] in your discourse directory.
  • JS Tests

    • Run ember s in the /manager-client directory
    • Open up your favorite browser and head to http://localhost:4200/testsand you should see all passing/failing tests

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

MIT