Github GitHub - Kovah/LinkAce: Your self-hosted bookmark archive. Free and open...

Your self-hosted bookmark archive. Free and open source.

Contents

About LinkAce

LinkAce is a bookmark archive. It wasn't built to manage the bookmarks of your browser but has its very own philosophy. My browser bookmarks contain only websites I regularly use and access. LinkAce, in contrast, is meant to provide a long-term archive of links to websites, media files or anything else which has a valid URL. I store interesting articles, neat web tools or libraries I may use sometime in the future.

Feature Highlights

• Save links with automatic title and description generation.
• Automated link monitoring informs you when any links become unavailable or were moved.
• Automated backups of saved sites via the Internet Archive.
• Organize bookmarks with the help of lists and tags.
• A full REST API offers access to all features of LinkAce from other apps and services.
• A bookmarklet to quickly save links from any browser.
• Links can be private or public, so friends or internet strangers may see your collection.
• Add notes to links to add thoughts or other relevant information.
• An advanced search including different filters and ordering.
• Import and export of bookmarks from HTML.
• Support for complete database and application backups to Amazon AWS S3.
• A built-in light and dark color scheme.

More features are already planned. Take a look at the project board for more information.

Documentation and Community

Any further information about all the available features and how to install the app, can be found on the LinkAce Website. Additionally, you may visit the community forums to share your ideas, talk with other users or find help for specific problems.

Support for LinkAce

I built LinkAce to solve my own problem, and I now offer my solution and code without charging anything. I spent a lot of my free time building this application already, so I won't offer any free personal support, customization or installation help. If you need help please visit the community forum and post your issue there.

You can get personal and dedicated support by becoming a Patreon or Github Sponsor.

Setup

LinkAce provides multiple ways of installing it on your server. The complete documentation for all installation methods can be found in the wiki.

• Setup with Docker (recommended)
  • Simple setup with 1 Docker image
  • Advanced setup with multiple Docker images
• Setup without Docker

Contribution

Please review the contribution guidelines before starting to work on any features.

Development

Requirements

1. Basic Setup

The following steps assume that you are using Docker for development, which I highly encourage. If you use other ways to work with PHP projects you must adapt the commands to your system. Clone the repository to your machine and run the following commands to start the Docker container system:

cp .env.docker .env
docker-compose up -d --build

Now, install all dependencies from inside the PHP container:

docker exec linkace-php bash -c "composer install"

Last step: compile all assets. Node 10 LTS is the minimum version required and recommended to use. You may use either NPM or Yarn for installing the asset dependencies.

npm install
OR
yarn install

npm run dev

2. Working with the Artisan command line

I recommend using the Artisan command line tool in the PHP container only, to make sure that the same environment is used. To do so, use the following example command:

docker exec linkace-php bash -c "php artisan migrate"

3. Registering a new user

Currently, you can do this by using the command line:

docker exec -it linkace-php bash -c "php artisan registeruser [user name] [user email]"

Tests

You can run existing tests with the following command:

docker exec -it linkace-php composer run tests

LinkAce is a project by Kovah | Contributors