{"id":13394109,"url":"https://github.com/jonschoning/espial","last_synced_at":"2025-05-14T11:10:53.369Z","repository":{"id":31771307,"uuid":"128848923","full_name":"jonschoning/espial","owner":"jonschoning","description":" Espial is an open-source, web-based bookmarking server.","archived":false,"fork":false,"pushed_at":"2024-12-30T21:06:59.000Z","size":30399,"stargazers_count":828,"open_issues_count":17,"forks_count":29,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-04-11T04:55:43.196Z","etag":null,"topics":["bookmark","bookmarking-server","database","demo","haskell","purescript"],"latest_commit_sha":null,"homepage":"","language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jonschoning.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-10T00:17:07.000Z","updated_at":"2025-04-10T02:47:28.000Z","dependencies_parsed_at":"2023-01-14T19:46:08.903Z","dependency_job_id":"8c3aa9d3-b2da-4762-ba9a-465294107127","html_url":"https://github.com/jonschoning/espial","commit_stats":{"total_commits":142,"total_committers":5,"mean_commits":28.4,"dds":0.07746478873239437,"last_synced_commit":"708cf33afbb3f04ffe797f737c96d9dfdecfbb5c"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschoning%2Fespial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschoning%2Fespial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschoning%2Fespial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschoning%2Fespial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonschoning","download_url":"https://codeload.github.com/jonschoning/espial/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254129489,"owners_count":22019628,"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","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":["bookmark","bookmarking-server","database","demo","haskell","purescript"],"created_at":"2024-07-30T17:01:09.232Z","updated_at":"2025-05-14T11:10:48.341Z","avatar_url":"https://github.com/jonschoning.png","language":"Haskell","readme":"# Espial\n\nEspial is an open-source, web-based bookmarking server.\n\nIt allows mutiple accounts, but currently intended for self-host scenarios.\n\nThe bookmarks are stored in a sqlite3 database, for ease of deployment \u0026 maintenence.\n\nThe easist way for logged-in users to add bookmarks, is with the \"bookmarklet\", found on the Settings page.\n\nAlso, see the android app for adding bookmarks via an Android Share intent https://github.com/jonschoning/espial-share-android\n\n## demo server\n\nlog in — username: demo  password: demo\n\nhttps://esp.ae8.org/u:demo\n\n![jpg](https://i.imgur.com/jdnV93c.png)\n\n## Docker Setup\n\nsee https://github.com/jonschoning/espial-docker\n\n## Server Setup (from source)\n\n1. Install the Stack executable here:\n    - https://tech.fpcomplete.com/haskell/get-started\n\n2. Build executables\n \n    ```\n    stack build\n    ```\n\n3. Create the database\n\n    ```\n    stack exec migration -- createdb --conn espial.sqlite3\n    ```\n\n4. Create a user\n\n    ```\n    stack exec migration -- createuser --conn espial.sqlite3 --userName myusername --userPassword myuserpassword\n    ```\n\n5. Import a pinboard bookmark file for a user (optional)\n\n    ```\n    stack exec migration -- importbookmarks --conn espial.sqlite3 --userName myusername --bookmarkFile sample-bookmarks.json\n    ```\n\n6. Import a firefox bookmark file for a user (optional)\n\n    ```\n    stack exec migration -- importfirefoxbookmarks --conn espial.sqlite3 --userName myusername --bookmarkFile firefox-bookmarks.json\n    ```\n\n7. Start a production server:\n\n    ```\n    stack exec espial\n    ```\n\n### Configuration\n\nSee `config/settings.yml` for changing default run-time parameters \u0026 environment variables.\n - `config/settings.yml` is embedded into the app executable when compiled, so after changing `config/settings.yml`, run `stack build` again to apply the new settings.\n - `config/settings.yml` values formatted like `_env:ENV_VAR_NAME:default_value` can be\n   overridden by the specified environment variable.\n - Example\n    - `_env:PORT:3000`\n        - environment variable `PORT`\n        - default app http port: `3000`\n\nSSL: use reverse proxy\n\n## Development \n\n### Backend\n\n- Install the `yesod` command line tool: `stack install yesod-bin --install-ghc`\n\n\n- Start a development server:\n\n    ```\n    yesod devel\n    ```\n\n### Frontend\n\n- See `purs/` folder\n\n## Import Bookmark file format (pinboard compatible format)\n\nsee `sample-bookmarks.json`, which contains a JSON array, each line containing a `FileBookmark` object. \n\nexample:\n\n```\n[ {\"href\":\"http://raganwald.com/2018/02/23/forde.html\",\"description\":\"Forde's Tenth Rule, or, \\\"How I Learned to Stop Worrying and \\u2764\\ufe0f the State Machine\\\"\",\"extended\":\"\",\"time\":\"2018-02-26T22:57:20Z\",\"shared\":\"yes\",\"toread\":\"yes\",\"tags\":\"raganwald\"},\n, {\"href\":\"http://downloads.haskell.org/~ghc/latest/docs/html/users_guide/flags.html\",\"description\":\"7.6. Flag reference \\u2014 Glasgow Haskell Compiler 8.2.2 User's Guide\",\"extended\":\"-fprint-expanded-synonyms\",\"time\":\"2018-02-26T21:52:02Z\",\"shared\":\"yes\",\"toread\":\"no\",\"tags\":\"ghc haskell\"},\n]\n```\n","funding_links":[],"categories":["Haskell","Software","Apps","Bookmarks and Link Sharing"],"sub_categories":["Bookmarks and Link Sharing","Bookmarking"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschoning%2Fespial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonschoning%2Fespial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschoning%2Fespial/lists"}