Import legacy wiki engines into LocalWiki
Project description
These are scripts to import legacy wiki engines (MediaWiki, Sycamore / WikiSpot.org) into LocalWiki.
Very rough right now. Please tell us about your experiences on #localwiki on Freenode.
Usage
-----
To import pages from an existing MediaWiki site into LocalWiki, do the following:
1. Activate the virtualenv used for LocalWiki (typical path shown)::
$ source /usr/share/localwiki/env/bin/activate
2. Install the localwiki-importers package::
(env)$ pip install localwiki-import-wikis
3. Add 'localwiki_importers' to LOCAL_INSTALLED_APPS in /usr/share/localwiki/conf/localsettings.py::
LOCAL_INSTALLED_APPS = ('import_wikis',)
4. Now you can run the import command like this::
$ localwiki-manage import_mediawiki
Follow the prompts to complete the import!
5. Build the search index::
$ localwiki-manage rebuild_index
6. The import will grab users and their edit history, but it won't import their
email address or password. If you have a way to obtain the old user
passwords, you can run the following::
$ localwiki-manage import_mediawiki --users_email_csv=<users_csv>
Where `users_csv` is a CSV file of the form username,email,<optional real name>.
Users will then be able to log in after they reset their password.
Here's how to get a users CSV file using MySQL::
SELECT user_name,user_email,user_real_name FROM wiki_user INTO OUTFILE '/tmp/users.csv' FIELDS TERMINATED BY ',' ENCLOSED BY '"' LINES TERMINATED BY '\n'
The file will then be at `/tmp/users.csv`.
Apache config
-------------
There is an example apache config in conf/ that will help with migrating
old mediawiki-style URLs. We strive for near 100% URL compatibility
with MediaWiki because breaking links just isn't cool.
------------
Copyright (c) 2012 Philip Neustrom <philipn@gmail.com>
Copyright (c) 2012 Mike Ivanov <mivanov@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Very rough right now. Please tell us about your experiences on #localwiki on Freenode.
Usage
-----
To import pages from an existing MediaWiki site into LocalWiki, do the following:
1. Activate the virtualenv used for LocalWiki (typical path shown)::
$ source /usr/share/localwiki/env/bin/activate
2. Install the localwiki-importers package::
(env)$ pip install localwiki-import-wikis
3. Add 'localwiki_importers' to LOCAL_INSTALLED_APPS in /usr/share/localwiki/conf/localsettings.py::
LOCAL_INSTALLED_APPS = ('import_wikis',)
4. Now you can run the import command like this::
$ localwiki-manage import_mediawiki
Follow the prompts to complete the import!
5. Build the search index::
$ localwiki-manage rebuild_index
6. The import will grab users and their edit history, but it won't import their
email address or password. If you have a way to obtain the old user
passwords, you can run the following::
$ localwiki-manage import_mediawiki --users_email_csv=<users_csv>
Where `users_csv` is a CSV file of the form username,email,<optional real name>.
Users will then be able to log in after they reset their password.
Here's how to get a users CSV file using MySQL::
SELECT user_name,user_email,user_real_name FROM wiki_user INTO OUTFILE '/tmp/users.csv' FIELDS TERMINATED BY ',' ENCLOSED BY '"' LINES TERMINATED BY '\n'
The file will then be at `/tmp/users.csv`.
Apache config
-------------
There is an example apache config in conf/ that will help with migrating
old mediawiki-style URLs. We strive for near 100% URL compatibility
with MediaWiki because breaking links just isn't cool.
------------
Copyright (c) 2012 Philip Neustrom <philipn@gmail.com>
Copyright (c) 2012 Mike Ivanov <mivanov@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file localwiki-import-wikis-0.3.3.tar.gz
.
File metadata
- Download URL: localwiki-import-wikis-0.3.3.tar.gz
- Upload date:
- Size: 40.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6423b7bcb485bd447fe7ed943592ec7ba0426d6d5d7ba3d4a1543014c43a3f2d |
|
MD5 | 79e8a30d53e2888525c09251b092b2ba |
|
BLAKE2b-256 | cb0ee897c039defd08db563de1e9f7aeac8b6c31dbf4f2a26b07a8616e7f26c4 |