Merge pull request #24 from AmRo045/dev

Add ability to update password & README improvement

Author: AmRo045

README.md

@@ -13,24 +13,25 @@ Outline Admin is a web interface for the Outline Manager API, providing a simple
 
 1. [Added Features](#added-features)
 2. [Installation](#installation)
-   - [Using Docker](#installation---docker)
-   - [Using Docker Compose](#using-docker-compose)
-   - [Using NodeJS](#installation---nodejs)
+   - [Docker](#docker)
+   - [Docker Compose](#docker-compose)
+   - [NodeJS](#nodejs)
 3. [Development](#development)
-4. [Donation](#donation)
-5. [Screenshots](#screenshots)
+4. [Admin Password](#admin-password)
+5. [Donation](#donation)
+6. [Screenshots](#screenshots)
 
 ## Added Features
 
-- Set expiration dates for Access Keys.
-- Generate QR codes for Access Keys.
-- Create dynamic Access Keys.
-- Add prefix to Access Keys.
+- Expiration dates for Access Keys.
+- QR codes for Access Keys.
+- Dynamic Access Keys.
+- Access Key prefix.
 
 
 ## Installation
 
-### Installation - Docker
+### Docker
 
 Before installing Outline Admin, ensure that Docker and Docker Compose are installed on your machine. Use the following commands to start the container:
 
@@ -39,7 +40,7 @@ Before installing Outline Admin, ensure that Docker and Docker Compose are insta
 docker run -d -p 3000:3000 --name outline-admin -v ./oa_data:/app/data --restart unless-stopped amro045/outline-admin:latest
 ```
 
-#### Using Docker Compose
+#### Docker Compose
 
 To simplify the installation, you can use a Docker Compose file:
 
@@ -51,7 +52,7 @@ wget -O docker-compose.yml https://raw.githubusercontent.com/AmRo045/OutlineAdmi
 docker compose up -d
 ```
 
-### Installation - NodeJS
+### NodeJS
 
 To run this project on your machine, ensure you have Node.js v20 or later and npm v10 or later installed.
 Follow the steps below to set up Outline Admin using Node.js:
@@ -130,6 +131,22 @@ npm run setup
 npm run dev
 ```
 
+## Admin Password
+
+To update the admin user password, use one of the following commands.
+
+For Docker containers:
+
+```bash
+docker exec -it outline-admin npm run password:change "your new password"
+```
+
+For non-Docker setup:
+
+```bash
+npm run password:change "your new password"
+```
+
 ## Donation
 
 If you find this project useful and would like to support its development, consider making a donation. Your support is greatly appreciated!

package.json

@@ -1,6 +1,6 @@
 {
     "name": "outline-admin",
-    "version": "0.1.10",
+    "version": "0.1.13",
     "private": true,
     "scripts": {
         "compile": "tsc -p tsconfig.scripts.json && tscpaths -p tsconfig.scripts.tscpaths.json -s ./dist -o ./dist",
@@ -10,6 +10,7 @@
         "build:docker": "node ./dist/scripts/build.js",
         "start": "echo cd into .next/standalone and run node server.js",
         "start:docker": "node ./dist/scripts/start.js",
+        "password:change": "node ./dist/scripts/change-password.js",
         "lint": "eslint ./scripts ./src --ext .ts,.tsx -c .eslintrc.json --fix",
         "format": "prettier --write ./src/**/*.{ts,tsx,json} ./scripts/**/*.{ts,tsx,json}",
         "format:check": "prettier --check ./src/**/*.{ts,tsx,json} ./scripts/**/*.{ts,tsx,json}",

scripts/change-password.ts

@@ -0,0 +1,42 @@
+import bcrypt from "bcrypt";
+import prisma from "@/prisma/db";
+
+const updatePassword = async (password: string): Promise<void> => {
+    const hashedPassword = await bcrypt.hash(password, 10);
+
+    const adminUser = await prisma.user.findFirst();
+
+    if (adminUser) {
+        await prisma.user.update({
+            where: { id: adminUser.id },
+            data: {
+                password: hashedPassword
+            }
+        });
+    } else {
+        await prisma.user.create({
+            data: {
+                password: hashedPassword
+            }
+        });
+    }
+};
+
+const main = async () => {
+    const args = process.argv.slice(2);
+    const password = args[0];
+
+    if (!password) {
+        console.error("Error: Password is required");
+        process.exit(1);
+    }
+
+    await updatePassword(password);
+
+    console.log("Password updated successfully.");
+};
+
+main().catch((error) => {
+    console.error("Unexpected error:", error);
+    process.exit(1);
+});

src/core/outline/outline-sync-service.ts

@@ -1,10 +1,11 @@
 /* eslint-disable no-console */
 import { AccessKey, Server } from "@prisma/client";
 
+import { MAX_DATA_LIMIT_FOR_ACCESS_KEYS } from "../config";
+
 import prisma from "@/prisma/db";
 import OutlineClient from "@/src/core/outline/outline-client";
 import { DataLimitUnit, Outline } from "@/src/core/definitions";
-import { MAX_DATA_LIMIT_FOR_ACCESS_KEYS } from "../config";
 
 export class OutlineSyncService {
     protected client: OutlineClient;
@@ -44,6 +45,7 @@ export class OutlineSyncService {
                 where: { id: this.server.id },
                 data: {
                     name: remoteServerInfo.name,
+                    hostnameOrIp: remoteServerInfo.hostnameForAccessKeys,
                     hostnameForNewAccessKeys: remoteServerInfo.hostnameForAccessKeys,
                     portForNewAccessKeys: remoteServerInfo.portForNewAccessKeys,
                     isMetricsEnabled: remoteServerInfo.metricsEnabled,