brian/wanderer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removes meili dump docs

Browse Source
This commit is contained in:
Christian Beutel
2025-01-26 18:16:48 +01:00
parent f34fd7afed
commit 763977c99f
3 changed files with 13 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/src/content/docs/getting-started/installation.mdx
View File

@@ -29,7 +29,7 @@ x-common-env: &cenv
services:
search:
container_name: wanderer-search
image: flomp/wanderer-search
image: getmeili/meilisearch:v1.11.3
environment:
<<: *cenv
MEILI_NO_ANALYTICS: true
@@ -125,12 +125,6 @@ While not recommended it is absolutely possible to install wanderer from source.
### meilisearch
wanderer uses meilisearch without any further modifications. As a result, you can simply head over to [their website](https://www.meilisearch.com/docs/learn/getting_started/installation) and follow the instructions for your preferred platform. We assume that you put the binary in the `wanderer/search` directory. If you did not, adapt the launch script below accordingly.
Furthermore, you will need to import the cities index manually. To do so launch meilisearch once with `--import-dump` parameter:
```bash
./meilisearch --import-dump migrations/migration.dump
```
Wait for the process to finish and terminate meilisearch afterwards.
### PocketBase
wanderer uses a slightly modified version of the PocketBase backend framework. As a result, you will need to build the PocketBase binary first.
```bash

14
docs/src/content/docs/getting-started/local-development.md
View File

@@ -31,17 +31,6 @@ Sometimes it can be useful to edit data directly in the database. `PocketBase` o
When you are done with development and would like to build wanderer for production there are some steps to follow.
### meilisearch
If you modified any attributes of one of the meilisearch indices (like filterable attributes), you will need to create a new dump that gets imported into wanderer on launch. To do so run
```bash
curl -X POST 'http://127.0.0.1:7700/dumps'
```
and overwrite the previous dump at `/search/migrations/migration.dump` with your updated one.
### PocketBase
If you modified code in any of the `*.go` files make sure to build an updated binary with `go build`. In case you only edited tables via the `PocketBase` admin panel you don't need to do anything. The database will be migrated automatically.
@@ -56,9 +45,6 @@ For the frontend there are no further caveats. Simply run `npm run build`.
To create local docker images of wanderer simply run the script below. These will work as drop-in replacements for the ones hosted on docker hub. This will only work if you have already completed the steps above.
```bash
# search
docker build search/ --no-cache -t flomp/wanderer-search:latest
# db
docker build db/ --no-cache -t flomp/wanderer-db:latest