{"id":13558101,"url":"https://github.com/captn3m0/outliner","last_synced_at":"2025-10-11T23:42:02.297Z","repository":{"id":49099963,"uuid":"198647758","full_name":"captn3m0/outliner","owner":"captn3m0","description":" A simple HTTParty based wrapper for the Outline API. Comes with ready scripts to import|export content from Outline.","archived":false,"fork":false,"pushed_at":"2024-03-07T08:05:05.000Z","size":32,"stargazers_count":19,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-09T20:53:56.937Z","etag":null,"topics":["backups","docker","export","getoutline","import","outline","outline-api","wiki"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/outliner","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/captn3m0.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"captn3m0","liberapay":"captn3m0","github":"captn3m0"}},"created_at":"2019-07-24T14:06:00.000Z","updated_at":"2025-05-19T13:36:56.000Z","dependencies_parsed_at":"2024-03-07T07:40:01.224Z","dependency_job_id":"07fcc32a-46a8-4c8c-b423-1254a211f866","html_url":"https://github.com/captn3m0/outliner","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/captn3m0/outliner","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/captn3m0%2Foutliner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/captn3m0%2Foutliner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/captn3m0%2Foutliner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/captn3m0%2Foutliner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/captn3m0","download_url":"https://codeload.github.com/captn3m0/outliner/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/captn3m0%2Foutliner/sbom","scorecard":{"id":265381,"data":{"date":"2025-08-11","repo":{"name":"github.com/captn3m0/outliner","commit":"b8872687308bf93cb4cae5214d252b59bf4019bd"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":1,"reason":"Found 2/20 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating ruby:3.3-alpine3.19 to ruby:3.3-alpine3.19@sha256:df76cf1f1dec4dad400437ce680f50f9420562f5d5ee6f8dfa7d7b967e76a36d","Info:   0 out of   1 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 17 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T11:53:50.543Z","repository_id":49099963,"created_at":"2025-08-17T11:53:50.543Z","updated_at":"2025-08-17T11:53:50.543Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271747023,"owners_count":24813604,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-23T02:00:09.327Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backups","docker","export","getoutline","import","outline","outline-api","wiki"],"created_at":"2024-08-01T12:04:44.864Z","updated_at":"2025-10-11T23:41:57.261Z","avatar_url":"https://github.com/captn3m0.png","language":"Ruby","funding_links":["https://ko-fi.com/captn3m0","https://liberapay.com/captn3m0","https://github.com/sponsors/captn3m0"],"categories":["Ruby","docker"],"sub_categories":[],"readme":"# Outliner [![Gem Version](https://badge.fury.io/rb/outliner.svg)](https://badge.fury.io/rb/outliner) [![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/captn3m0/outliner)](https://hub.docker.com/r/captn3m0/outliner) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/captn3m0/outliner)](https://hub.docker.com/r/captn3m0/outliner) [![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/captn3m0/outliner)](https://hub.docker.com/r/captn3m0/outliner)\n\nA simple HTTParty based wrapper for the [Outline API](https://www.getoutline.com/developers). 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.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'outliner'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install outliner\n\n## Usage\n\nThe 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.\n\n```ruby\nrequire 'outliner'\n\nclient = Outliner.new('https://knowledge.example.com')\npp client.auth_info\npp client.collections_list(offset: 0, limit: 10)\n# This works around a 302 redirect bug in httparty\nbegin\n  r = @client.fileOperations__redirect({id: FILE_OPERATION_ID}, format: nil, no_follow: true)\nrescue HTTParty::RedirectionTooDeep =\u003e e\n  # Download this using response = HTTParty.get e.response.header['location'] if needed\n  pp e.response.header['location']\nend\n```\n\n### Import\n\n`outliner` can be used to import an existing collection of documents into Outline. To do this, run:\n\n```bash\nexport OUTLINE_BASE_URI=\"https://kb.example.com\"\nexport OUTLINE_TOKEN=\"PUT YOUR TOKEN HERE\"\nexport SOURCE_DIRECTORY=\"/home/user/wiki\"\nexport DESTINATION_COLLECTION_NAME=\"Archive\"\nbundle install outliner\noutliner-import \"$SOURCE_DIRECTORY\" \"$DESTINATION_COLLECTION_NAME\"\n```\n\n### Export\n\n`outliner` can be used to run a one-time export of all documents in Outline to a local directory. To do this, run:\n\n```bash\nexport OUTLINE_BASE_URI=\"https://kb.example.com\"\nexport OUTLINE_TOKEN=\"PUT YOUR TOKEN HERE\"\n# Ensure that this exists and is writable\nexport DESTINATION_DIRECTORY=\"/data\"\nbundle install outliner\noutliner-export \"$DESTINATION_DIRECTORY\"\n```\n\n## Docker\n\nYou can use the pre-built docker image to run the above commands as well. See the following commands for examples:\n\n### Setup\n\nCopy the `env.sample` file to `.env` and update the values there.\n\n### Export\n\nDownloads all collections from Outline, and exports them as nested markdown files inside the given directory (`/data` inside the container, mount it accordingly.)\n\n```bash\ndocker run --env-file .env\n           --volume /tmp:/data \\\n           captn3m0/outliner \\\n           export \\\n           /data\n```\n\n### Import\n\nImports all markdown documents in a directory to a named Collection on outline. Creates the collection if it doesn't exist.\n\n```bash\ndocker run --env-file .env\n           --volume /path/to/wiki:/data \\\n           captn3m0/outliner \\\n           import /data \"Archive\"\n```\n\n### Sync\n\nDoes a export from Outline, and pushes the corresponding result to the Git repository. Currenly does a force-push to the repository. Use with care.\n\nNote: Sync is currently only available as a Docker Command\n\n```bash\ndocker run --env-file .env\n           --volume /etc/ssh/private.key:/root/.ssh/id_rsa\n           captn3m0/outliner \\\n           sync\n```\n\n#### Limitations\n\n- [import] Images are currently not imported. Host them externally for this to work.\n- [import] Only `.md` files are currently supported\n- [docker] `StrictHostKeyChecking` is currently disabled for `push`, please only run this in trusted networks.\n\n## Development\n\nAfter 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.\n\nTo 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](https://rubygems.org).\n\n## Contributing\n\nBug 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](http://contributor-covenant.org) code of conduct.\n\n## Code of Conduct\n\nEveryone interacting in the Outliner project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/captn3m0/outliner/blob/master/CODE_OF_CONDUCT.md).\n\n## License\n\nLicensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaptn3m0%2Foutliner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaptn3m0%2Foutliner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaptn3m0%2Foutliner/lists"}