Skip to content
master
Go to file
Code

Latest commit

* Fixed errors in both actions.yml files. There was a typo in the job dependency name.

* Changes to docker-related Actions files

Have removed the "on PR to master branch" condition in the
`build-docker-on-push-master.yml` file as this was causing the builds to
run when a PR was created. This could result in images being pushed to
DockerHub with changes that were not yet merged into `master`.

Have changed the version of the `checkout` action from `v1` to `v2` in
`build-docker-on-push-master.yml` and `build-docker-on-release.yml`.

* Fixed errors in docker-related actions files

In files `build-docker-on-push-master.yml` and
`build-docker-on-release.yml`, the `--build-arg` value needs to be in
the form of `KEY=VALUE`. Instead, it was `KEY VALUE`. Have fixed this.

* Migrated to official actions where possible in actions files.

* Changed Dockerfile to Dockerfile.source in action file which builds image based on master branch.

* Fixed errors in actions files.

In `build-docker-on-push-master.yml`, the job `buildPushUntested` was
referring to a variable `tag_name` instead of `image_tag`. Fixed this.

In `build-docker-on-release.yml`, the conditions which trigger the run
were `on publish of release`. This wasn't getting triggered when tags
were being pushed, which is needed. Have added a condition `on push of
tags`.

Also, there's an error in the linting step(`Hadolint`). This will be
fixed in the `docker` branch.
305cbf4

Git stats

Files

Permalink
Failed to load latest commit information.

README.md

Archivy

Archivy is a self-hosted knowledge repository that allows you to safely preserve useful content that contributes to your knowledge bank.

Features:

  • If you add bookmarks, their webpages contents' will be saved to ensure that you will always have access to it, following the idea of digital preservation.
  • Backend API for flexibility and user enhancements
  • Everything is a file! For ease of access and editing, all the content is stored in markdown files with yaml front matter.
  • Extensible search with Elasticsearch and its Query DSL
  • Allows you to sync up with Pocket to gather bookmarks from there too.

demo (low res)

Upcoming:

  • Integrations with HN, Reddit, and many more.
  • Login module
  • Add submodules for digital identity so archivy syncs to your hn upvoted posts, reddit saved, etc...
  • Option to compile data to a static site that can be deployed.
  • Dark theme
  • UI for grouping by tag and use NLP to automatically generate connections between posts

Setup

Local Setup

  • Make sure your system has Python and pip installed.
  • Install the python package with pip install archivy
  • There you go! You should be able to start the app by running archivy in your terminal.

Configuration

Archivy uses environment variables for its configuration:

Variable Default Description
ARCHIVY_DATA_DIR System-dependant, see below Directory in which data will be saved
ARCHIVY_PORT 5000 Port on which archivy will run
ELASTICSEARCH_ENABLED 0 Enable Elasticsearch integration
ELASTICSEARCH_URL http://localhost:9200 Url to the elasticsearch server

ARCHIVY_DATA_DIR by default will be set by the appdirs python library:

On Linux systems, it follows the XDG specification: ~/.local/share/archivy

With Docker

See the docker branch for details on setting things up with docker.

Setting up Search

Archivy uses ElasticSearch to provide efficient full-text search.

Instructions to install and run the service are provided here.

Append these two lines to your elasticsearch.yml config file:

http.cors.enabled: true
http.cors.allow-origin: "http://localhost:5000"

Run archivy like this:

ELASTICSEARCH_ENABLED=1 archivy

Usage

The first time you run archivy, an admin user will automatically be created with a random password. These credentials will be printed to the log when you launch like this:

[2020-10-10 10:48:27,764] INFO in __init__: Archivy has created an admin user as it did not exist.
                            Username: 'admin', password: '5a512991c605ea51038ce2a0'

Login with these credentials and then you can change your password/username by clicking the profile button on the top left.

You can then use archivy to create notes, organize it and store information.

Community and Development

If you're interested in developing and improving Archivy, please join our community discord server.

Feel free to open issues if you encounter bugs, have any ideas / feature requests and use the discord server for more casual discussion.

About

Archivy is a self-hosted knowledge repository that allows you to safely preserve useful content that contributes to your knowledge bank.

Topics

Resources

License

Packages

No packages published
You can’t perform that action at this time.