Skip to content

Commit

Permalink
Fix naming
Browse files Browse the repository at this point in the history
  • Loading branch information
mbround18 committed Aug 21, 2024
1 parent a8c932d commit b8136e7
Show file tree
Hide file tree
Showing 9 changed files with 69 additions and 4,770 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:
- name: Create ZIP file
run: |
cd pkg && zip -r ../millisearch.zip ./*
cd pkg && zip -r ../meilisearch.zip ./*
- name: Check for VERSION changes
id: check_version
Expand All @@ -74,6 +74,6 @@ jobs:
VERSION=$(cat VERSION)
TAG="v$VERSION"
echo "Creating Release $TAG"
gh release create $TAG millisearch.zip --title "$TAG" --notes "Release notes for version $VERSION"
gh release create $TAG meilisearch.zip --title "$TAG" --notes "Release notes for version $VERSION"
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
name = "wiki_millisearch"
name = "wiki_meilisearch"
version = "0.1.0"
edition = "2021"

[lib]
crate-type = ["cdylib"]
name = "millisearch"
name = "meilisearch"
path = "src/lib.rs"

[dependencies]
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Variables
PROJECT_NAME := wiki_millisearch
PROJECT_NAME := wiki_meilisearch
DOCKER_COMPOSE := docker-compose.yml
PKG_DIR := pkg
SOURCE_FILES := engine.js definition.yml
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# WikiJS Module | Millisearch
# WikiJS Module | Meilisearch

## Description

This module is a plugin for the [WikiJS](https://wiki.js.org/) software. It allows you to use the [Millisearch](https://millisearch.com/) search engine to index and search your wiki content.
This module is a plugin for the [WikiJS](https://wiki.js.org/) software. It allows you to use the [Meilisearch](https://meilisearch.com/) search engine to index and search your wiki content.

## Pre-requisites

1. A running instance of Millisearch
1. A running instance of Meilisearch
2. A running instance of WikiJS

## Installation

1. Navigate to the latest release of the module on the [releases page](https://github.com/mbround18/wikijs-module-millisearch/releases).
2. Download the `millisearch.zip` file.
3. Extract the contents of the zip file into the `/wiki/server/modules/millisearch` directory.
1. Navigate to the latest release of the module on the [releases page](https://github.com/mbround18/wikijs-module-meilisearch/releases).
2. Download the `meilisearch.zip` file.
3. Extract the contents of the zip file into the `/wiki/server/modules/meilisearch` directory.
4. Restart your WikiJS server.
5. Navigate to your admin panel
6. Click on the `Search` tab
7. Select `Millisearch` from the dropdown
8. Enter the URL of your Millisearch server (e.g. `http://localhost:7700`)
7. Select `Meilisearch` from the dropdown
8. Enter the URL of your Meilisearch server (e.g. `http://localhost:7700`)
9. Change the API key
10. Click `Apply`

Expand Down
22 changes: 11 additions & 11 deletions definition.yml
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
key: millisearch
title: Millisearch Engine
key: meilisearch
title: Meilisearch Engine
author: mbround18
isAvailable: true
logo: https://raw.githubusercontent.com/mbround18/wikijs-module-millisearch/main/docs/assets/logo.png
website: https://github.com/mbround18/wikijs-module-millisearch
logo: https://raw.githubusercontent.com/mbround18/wikijs-module-meilisearch/main/docs/assets/logo.png
website: https://github.com/mbround18/wikijs-module-meilisearch
props:
millisearchHost:
meilisearchHost:
type: String
description: "The URL or IP address where the Millisearch server is hosted."
default: "http://millisearch:7700"
millisearchApiKey:
description: "The URL or IP address where the Meilisearch server is hosted."
default: "http://meilisearch:7700"
meilisearchApiKey:
type: String
description: "API key for authenticating requests to the Millisearch server."
description: "API key for authenticating requests to the Meilisearch server."
default: "demo"
indexName:
type: String
description: "The name of the index in Millisearch that will be used for the Wiki.js search."
description: "The name of the index in Meilisearch that will be used for the Wiki.js search."
default: "wiki_index"
timeout:
type: Number
description: "Timeout for search requests in milliseconds."
description: "Timeout for search requests in meiliseconds."
default: 5000
12 changes: 6 additions & 6 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ services:
environment:
DB_TYPE: sqlite
volumes:
- ./pkg:/wiki/server/modules/search/millisearch
- ./pkg:/wiki/server/modules/search/meilisearch
- ./tmp/wikijs:/wiki/data:rw
- ./config/wiki.yml:/wiki/config.yml:r
depends_on:
- millisearch
- meilisearch
links:
- millisearch
- meilisearch

millisearch:
meilisearch:
image: getmeili/meilisearch:v1.9
container_name: millisearch
container_name: meilisearch
restart: always
ports:
- "7700:7700"
Expand All @@ -27,4 +27,4 @@ services:
MEILI_NO_ANALYTICS: "true"
MEILI_LOG_LEVEL: "DEBUG"
volumes:
- ./tmp/millisearch:/meili_data
- ./tmp/meilisearch:/meili_data
Loading

0 comments on commit b8136e7

Please sign in to comment.