Your selfhosted bookmark archive with a simple interface and advanced features.
:warning: This application is still in development! :warning:
### Contents * [About LinkAce](#about-linkace) * [Support Disclaimer](#bulb-support-for-linkace) * [Setup](#gear-setup) * [Contribution](#construction-contribution) * [Development](#development) --- ### About LinkAce  LinkAce is a bookmark manager similar to Shaarli and other tools. I built this tool to have something that fits my actual needs which other bookmark managers couldn't solve, even if most features are almost the same. #### Features * Save links with automatic title and description generation. * Automated link checks to make sure your bookmarks stay available. * Automated “backups” of your bookmarks via the Waybackmachine. * Organize bookmarks in lists and tags. * A bookmarklet to quickly save links from any browser. * Private or public links, so friends or internet strangers can see your collection. * Add notes to links to add thoughts or other information. * Advanced search including different filters and ordering. * Import existing bookmarks from HTML exports (other methods planned). * Support for complete database and app 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](https://github.com/Kovah/LinkAce/projects/1) 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](https://www.linkace.org/). Additionally, you may visit the [community forums](https://spectrum.chat/linkace/) to share your ideas, talk with other users or find help for specific problems. --- ### :bulb: Support for LinkAce Free support is highly limited for all my free tools, including LinkAce. If you need help please visit the [community forum](https://spectrum.chat/linkace/) and post your issue there. I do not offer free personal support via chat or email. Please notice that LinkAce has specific requirements to run correctly. If you need prioritized support you can **become a [Patreon](https://www.patreon.com/Kovah)** or **[Github Sponsor](https://github.com/sponsors/Kovah)**. :star: --- ### :gear: Setup LinkAce provides multiple ways of installing it on your server. The complete documentation for all installation methods can be found [**in the wiki**](https://www.linkace.org/docs/v1/setup/). * Setup with Docker (_recommended_) * Simple setup with 1 Docker image * Advanced setup with multiple Docker images * Setup without Docker --- ### :construction: Contribution Please review the [**contribution guidelines**](CONTRIBUTING.md) before starting to work on any features. ### Development #### Requirements * [Docker](https://www.docker.com/products/docker-desktop) * [Node](https://nodejs.org/en/) (12 LTS) #### 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: ```bash cp .env.docker .env docker-compose up -d --build ``` Now, install all dependencies from inside the PHP container: ```bash 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. ```bash 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: ```bash docker exec linkace-php bash -c "php artisan migrate" ``` #### 3. Registering a new user Currently, you can do this by using the command line: ```bash docker exec -it linkace-php bash -c "php artisan registeruser [user name] [user email]" ``` #### Tests You can run existing tests with the following command: ```bash docker exec -it linkace-php composer run tests ``` --- LinkAce is a project by [Kovah](https://kovah.de) | [Contributors](https://github.com/Kovah/LinkAce/graphs/contributors)