A simple HTTParty based wrapper for the Outline API. Comes with ready scripts to import|export content from Outline.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Nemo 969f704f31
Create FUNDING.yml
4 weeks ago
.github Create FUNDING.yml 4 weeks ago
bin [docker] Adds export and general re-org 3 years ago
exe [style] Fixes rubocop warnings 3 years ago
lib Version Bump (1.0.1) 2 years ago
test Initial Commit 3 years ago
.dockerignore [docker] Adds export and general re-org 3 years ago
.editorconfig Adds import script 3 years ago
.gitignore [sync] Adds proper sync support 2 years ago
CHANGELOG.md Version Bump (1.0.1) 2 years ago
CODE_OF_CONDUCT.md Initial Commit 3 years ago
Dockerfile [sync] Adds proper sync support 2 years ago
Gemfile Initial Commit 3 years ago
LICENSE [sync] Adds proper sync support 2 years ago
README.md Version Bump (1.0.0) 2 years ago
Rakefile Sets up Rakefile 3 years ago
entrypoint.sh [sync] Adds proper sync support 2 years ago
env.sample [sync] Adds proper sync support 2 years ago
outliner.gemspec Dependency updates 2 years ago

README.md

Outliner Gem Version Docker Cloud Build Status Docker Image Version (latest semver) Docker Image Size (latest semver)

A simple HTTParty based wrapper for the Outline API. It also offers a one-line import option to let you migrate an existing set of Markdown files to Outline. For quickly running export/import commands, you can use the Docker Image as well.

Installation

Add this line to your application's Gemfile:

gem 'outliner'

And then execute:

$ bundle

Or install it yourself as:

$ gem install outliner

Usage

The API Client automatically picks up the Token from the OUTLINE_TOKEN environment variable. All the API calls are available with the . replaced with a _ in the method name. So if you need to call the collections.remove_user API, use the collections_remove_user method.

require 'outliner'

client = Outliner.new('https://knowledge.example.com')
pp client.auth_info
pp client.collections_list(offset: 0, limit: 10)

Import

outliner can be used to import an existing collection of documents into Outline. To do this, run:

export OUTLINE_BASE_URI="https://kb.example.com"
export OUTLINE_TOKEN="PUT YOUR TOKEN HERE"
export SOURCE_DIRECTORY="/home/user/wiki"
export DESTINATION_COLLECTION_NAME="Archive"
bundle install outliner
outliner-import "$SOURCE_DIRECTORY" "$DESTINATION_COLLECTION_NAME"

Export

outliner can be used to run a one-time export of all documents in Outline to a local directory. To do this, run:

export OUTLINE_BASE_URI="https://kb.example.com"
export OUTLINE_TOKEN="PUT YOUR TOKEN HERE"
# Ensure that this exists and is writable
export DESTINATION_DIRECTORY="/data"
bundle install outliner
outliner-export "$DESTINATION_DIRECTORY"

Docker

You can use the pre-built docker image to run the above commands as well. See the following commands for examples:

Setup

Copy the env.sample file to .env and update the values there.

Export

Downloads all collections from Outline, and exports them as nested markdown files inside the given directory (/data inside the container, mount it accordingly.)

docker run --env-file .env
           --volume /tmp:/data \
           captn3m0/outliner \
           export \
           /data

Import

Imports all markdown documents in a directory to a named Collection on outline. Creates the collection if it doesn't exist.

docker run --env-file .env
           --volume /path/to/wiki:/data \
           captn3m0/outliner \
           import /data "Archive"

Sync

Does a export from Outline, and pushes the corresponding result to the Git repository. Currenly does a force-push to the repository. Use with care.

Note: Sync is currently only available as a Docker Command

docker run --env-file .env
           --volume /etc/ssh/private.key:/root/.ssh/id_rsa
           captn3m0/outliner \
           sync

Limitations

  • [import] Images are currently not imported. Host them externally for this to work.
  • [import] Only .md files are currently supported
  • [docker] StrictHostKeyChecking is currently disabled for push, please only run this in trusted networks.

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/captn3m0/outliner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the Outliner project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

License

Licensed under the MIT License. See LICENSE file for details.